Message object

Message represents a single message published on a chat channel.

Properties

The Message interface has the following properties:

1interface Message {
2    val chat: Chat
3    val timetoken: Long
4    val content: EventContent.TextMessageContent
5    val channelId: String
6    val userId: String
7    val actions: Map<String, Map<String, List<Action>>>?
8    val meta: Map<String, Any>?
9    val mentionedUsers: MessageMentionedUsers? // deprecated
10    val referencedChannels: MessageReferencedChannels? // deprecated
11    val quotedMessage: QuotedMessage?
12    val text: String
13    val deleted: Boolean
14    val hasThread: Boolean
15    val files: List<File>
16    val reactions: List<MessageReaction>
17    val textLinks: List<TextLink>? // deprecated
18

19    ...
20}

show all 20 lines

chat#

type: Type: Chat

Reference to the main Chat object.

timetoken#

type: Type: Long

Unique identifier for the message, possibly a timestamp or similar value that helps order messages in a conversation.

content#

type: Type: EventContent.TextMessageContent

Original text content of the message.

channelId#

type: Type: String

Unique identifier for the channel or group in which the message was sent.

userId#

type: Type: String

Unique ID of the user who sent the message.

actionsDeprecated#

type: Type: Map<String, Map<String, List<Action>>>

Deprecated. Use reactions instead.

meta#

type: Type: Map<String, Any>

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}.

mentionedUsersDeprecated#

type: Type: MessageMentionedUsers

List of mentioned users with IDs and names.

referencedChannelsDeprecated#

type: Type: MessageReferencedChannels

List of referenced channels with IDs and names.

quotedMessage#

type: Type: QuotedMessage

List of quoted messages with their timetokens, content, and authors' IDs.

text#

type: Type: String

Content of the message.

deleted#

type: Type: Boolean

Whether the message is soft deleted.

hasThread#

type: Type: Boolean

Whether any thread has been created for this message.

files#

type: Type: List<File>

List of attached files with their names, types, and sources.

reactions#

type: Type: List<MessageReaction>

List of reactions attached to the message. Each MessageReaction contains a value (the emoji string), isMine (whether the current user added it), userIds (list of users who added it), and count (number of users).

textLinksDeprecated#

type: Type: List<TextLink>

List of included text links and their position.

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

1@Serializable
2sealed class EventContent {
3

4    ...
5

6    @Serializable
7    @SerialName("text")
8    open class TextMessageContent(
9        val text: String,
10        val files: List<File>? = null,
11    ) : EventContent() {
12        override fun equals(other: Any?): Boolean {
13            if (this === other) return true
14            if (other !is TextMessageContent) return false
15

16            if (text != other.text) return false
17            if (files != other.files) return false
18

19            return true
20        }
21

22        override fun hashCode(): Int {
23            var result = text.hashCode()
24            result = 31 * result + (files?.hashCode() ?: 0)
25            return result
26        }
27

28        override fun toString(): String {
29            return "TextMessageContent(text='$text', files=$files)"
30        }
31    }
32

33    class UnknownMessageFormat(val jsonElement: JsonElement) : TextMessageContent("", null)
34}

show all 34 lines

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.

1enum class MessageActionType {
2    REACTIONS,
3    DELETED,
4    EDITED;
5

6    override fun toString(): String {
7        return name.lowercase()
8    }
9}

Message-related types

Methods

The Message object exposes the following methods and properties.

Regular methods

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

Event listeners

• onUpdated()
• streamUpdates() (deprecated)
• 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