Message object

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

Properties

The MessageImpl class implements the Message protocol and takes the following properties:

extension MessageImpl: Message {
    public var chat: ChatImpl
    public var timetoken: Timetoken
    public var content: EventContent.TextMessageContent
    public var channelId: String
    public var userId: String
    public var actions: [String: [String: [Action]]]?
    public var meta: [String: JSONCodable]?
    public var mentionedUsers: MessageMentionedUsers? // deprecated
    public var referencedChannels: MessageReferencedChannels? // deprecated
    public var quotedMessage: QuotedMessage?
    public var text: String
    public var deleted: Bool
    public var hasThread: Bool
    public var files: [File]

show all 20 lines

Parameter	Type	Description
chat	ChatImpl	Reference to the main Chat protocol.
timetoken	Timetoken	Unique identifier for the message, possibly a timestamp or similar value that helps order messages in a conversation.
content	EventContent.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	[String: [String: [Action]]]	Any actions associated with the message, such as reactions, replies, or other interactive elements.
meta	[String: JSONCodable]?	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}.
mentionedUsers	MessageMentionedUsers	List of mentioned users with IDs and names.
referencedChannels	MessageReferencedChannels	List of referenced channels with IDs and names.
quotedMessage	QuotedMessage	List of quoted messages with their timetokens, content, and authors' IDs.
text	String	Content of the message.
deleted	Bool	Whether the message is soft deleted.
hasThread	Bool	Whether any thread has been created for this message.
files	[File]	List of attached files with their names, types, and sources.
reactions	[String: [Action]]	List of reactions attached to the message.
textLinks	[TextLink]	List of included text links and their position.

Message-related types

Methods

You can call the following methods and properties on the Message object.

Click on each method or property for more details.

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

Use case

For example, you can use the Message-related methods to:

• Let users send, 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.