Message object

Message represents a single message published on a chat channel.

Properties

Message has the following properties:

1class Message {
2    timetoken: string,
3    content: TextMessageContent,
4    channelId: string,
5    userId: string,
6    actions?: MessageActions,
7    reactions?: MessageReaction[],
8    meta?: {
9        [key: string]: any
10    },
11    error?: string
12}

Parameter	Description
timetoken Type: string	Unique identifier for the message, possibly a timestamp or similar value that helps order messages in a conversation.
content Type: TextMessageContent	Original text content of the message.
channelId Type: string	Unique identifier for the channel or group in which the message was sent.
userId Type: string	Unique ID of the user who sent the message.
actions Type: MessageActions or undefined	Deprecated. Any actions associated with the message, such as reactions, replies, or other interactive elements.
reactions Type: MessageReaction[] or undefined	List of reactions. Each MessageReaction has value (emoji string), isMine (boolean), and userIds (string array).
meta Type: object or undefined	Extra information added to the message giving additional context. This object can be of any type and can consist of a list of key-value pairs. For example, {language: 'English', wordCount: 42}.
error Type: string or undefined	Error added to the message when either the message or files it contains couldn't be decrypted. For more information, refer to the Data security section.

The message and message action types defined for the Message object take the following parameters:

• TextMessageContent

  1type TextMessageContent = {
  2    type: MessageType.TEXT;
  3    text: string;
  4    files?: {
  5        name: string;
  6        id: string;
  7        url: string;
  8        type?: string
  9    }[]

• MessageActions

  1type MessageActions = {
  2    [type: string]: {
  3        [value: string]: {
  4            uuid: string;
  5            actionTimetoken: string | number;
  6        }[];
  7    };
  8}

A single text message has the text type.

1export enum MessageType {
2  TEXT = "text"
3}

Depending on how a message was manipulated (what action was taken on it), it is assigned a different action type (for adding a message reaction to a message, editing, or deleting a message). For example, MessageActionType.EDITED.

1export enum MessageActionType {
2  REACTIONS = "reactions",
3  DELETED = "deleted",
4  EDITED = "edited",
5}

Message-related types

Methods

Available methods:

Regular methods

• createThread()
• createThreadWithResult()
• createThreadMessageDraft()
• delete()
• (getter) deleted
• (getter) hasThread
• editText()
• forward()
• getMessageElements()
• getThread()
• hasUserReaction()
• toggleReaction()
• pin()
• (getter) quotedMessage
• (getter) reactions
• removeThread()
• report()
• restore()
• (getter) text

Event listeners

• onUpdated()
• streamUpdates() (deprecated)
• (static) streamUpdatesOn()

Use case

Message methods enable:

• Updating and deleting messages
• Forwarding messages to others
• Pinning messages to channels
• Quoting messages
• Reacting to messages
• Reporting offensive messages