Rate this page:

Message

Interface representing a message within a conversation.

Methods

edit

Copy URL

Promise<ConversationMessageEventPayload>

edit(

MessageEditOptions

options
)

Sends text and payload changes to the cloud.

Triggers the MessengerEventType.onEditMessage event for all participants in the conversation (online users and logged-in clients).

Throws a MessengerError if:

Returns a promise that resolves with a ConversationMessageEventPayload object.

Parameters

Returns

remove

Copy URL

Promise<ConversationMessageEventPayload>

remove()

Deletes the message in the conversation.

Triggers the MessengerEventType.onRemoveMessage event for all participants in the conversation (online users and logged-in clients).

Throws a MessengerError if:

Returns a promise that resolves with a ConversationMessageEventPayload object.

Returns

Props

conversation

Copy URL
 conversation

The UUID of the conversation where the message has been posted.

payload

Copy URL
 payload

Array of payload objects associated with the message.

sequence

Copy URL
 sequence

Message sequence number in the conversation.

text

Copy URL
 text

The message text.

uuid

Copy URL
 uuid

The universally unique identifier (UUID) of the message.