Skip to main content

Overview

Returns an async function that soft-deletes a message. The message is removed from the local Redux store immediately. On the server, the message’s content is cleared and userDeletedAt is set — the record is retained for threading consistency.
Requires ChatProvider in the component tree.

Usage Example

Parameters

The hook returns a function. That function accepts:
conversationId
string
required
The ID of the conversation that contains the message.
messageId
string
required
The ID of the message to delete.

Returns

Promise<void>

Notes

  • Other participants see the deletion in real-time via the message:deleted socket event, which is handled automatically by ChatProvider. Their local copy of the message will have userDeletedAt set and content: null.
  • For integration guidance, see Chat: Messages.