Message object

Message is an object that refers to a single message published on a chat channel.

Properties

The Message object has the following properties:

class Message {
    timetoken: string,
    content: TextMessageContent,
    channelId: string,
    userId: string,
    actions?: MessageActions,
    meta?: {
        [key: string]: any
    },
    error?: string
}

Parameter	Type	Description
timetoken	string	Unique identifier for the message, possibly a timestamp or similar value that helps order messages in a conversation.
content	TextMessageContent	Original text content of the message.
channelId	string	Unique identifier for the channel or group in which the message was sent.
userId	string	Unique ID of the user who sent the message.
actions	MessageActions or undefined	Any actions associated with the message, such as reactions, replies, or other interactive elements.
meta	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	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.

Message-related types

Methods

You can call the following methods on the Message object.

Click on each method for more details.

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

Use case

For example, you can use the Message object methods to:

• Let users update and delete messages.
• Forward messages to others.
• Pin messages to channels.
• Quote messages.
• React to messages.
• Report messages to the admin if they are offensive.