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:

1extension MessageImpl: Message {
2    public var chat: ChatImpl
3    public var timetoken: Timetoken
4    public var content: EventContent.TextMessageContent
5    public var channelId: String
6    public var userId: String
7    public var actions: [String: [String: [Action]]]?
8    public var meta: [String: JSONCodable]?
9    public var mentionedUsers: MessageMentionedUsers? // deprecated
10    public var referencedChannels: MessageReferencedChannels? // deprecated
11    public var quotedMessage: QuotedMessage?
12    public var text: String
13    public var deleted: Bool
14    public var hasThread: Bool
15    public var files: [File]
16    public var reactions: [String: [Action]]
17    public var textLinks: [TextLink]? // deprecated
18

19    ...
20}

show all 20 lines

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

The TextMessageContent type defined for the MessageImpl object takes the following parameters:

1public class TextMessageContent: EventContent {
2  public let text: String
3  public let files: [File]?
4   
5  public init(text: String, files: [File]? = nil) {
6    self.text = text
7    self.files = files
8  }
9   
10}

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.

1public enum MessageActionType: String {
2  case reactions
3  case deleted
4  case edited
5}

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.