Rate this page:

VIMessage

Interface that represents message within a conversation.

Methods

remove

Copy URL

Future<VIMessageEvent>

remove()

Remove the message from the conversation.

The participant that calls this method should have:

Returns

update

Copy URL

Future<VIMessageEvent>

update({

String

text,

List<Map<String, Object>>

payload
}
)

Send text and payload changes to the cloud.

The participant that calls this method should have:

To be informed about the message updating while being offline, participants can subscribe to the onEditMessage messenger push notification.

Parameters

  • text:

    String

    Optional

    New text of this message, maximum 5000 characters. If null, message text will not be updated.

  • payload:

    List<Map<String, Object>>

    Optional

    New payload of this message. If null, message payload will not be updated.

Returns

Props

conversation

Copy URL

String

conversation

The UUID of the conversation this message belongs to.

The message can belong to the one conversation only.

Returns

  • type:

    String

payload

Copy URL

List<Map<String, dynamic>>

payload

The list of payload objects associated with the message.

Returns

  • type:

    List<Map<String, dynamic>>

sequence

Copy URL

int

sequence

The message sequence number in the conversation.

Returns

  • type:

    int

text

Copy URL

String

text

The text of this message.

Returns

  • type:

    String

uuid

Copy URL

String

uuid

The universally unique identifier (UUID) of the message.

Returns

  • type:

    String