Event object

Event represents a single piece of information emitted during chat operations: typing indicators, message receipts, mentions, or reports.

Unlike other Chat SDK entities, Event provides no methods - it only passes payloads emitted during chat operations.

Properties

The Event interface has the following properties:

1class Event<T : EventContent>(
2    val chat: Chat,
3    val timetoken: Long,
4    val payload: T,
5    val channelId: String,
6    val userId: String
7)

Parameter	Description
chat Type: Chat	Reference to the main Chat object.
timetoken Type: Long	Timetoken of the message that triggered an event.
payload Type: T	Data passed in an event (of EventContent subtype) that differ depending on the emitted event type (typing, report, receipt, mention, invite, custom, moderation, or text).
channelId Type: String	Target channel where this event is delivered.
userId Type: String	Unique ID of the user that triggered the event.

The EventContent class takes the following parameters:

1@Serializable
2sealed class EventContent {
3    @Serializable
4    @SerialName("typing")
5    class Typing(val value: Boolean) : EventContent()
6

7    @Serializable
8    @SerialName("report")
9    class Report(
10        val text: String? = null,
11        val reason: String,
12        val reportedMessageTimetoken: Long? = null,
13        val reportedMessageChannelId: String? = null,
14        val reportedUserId: String?,
15    ) : EventContent()
16

17    @Serializable
18    @SerialName("receipt")
19    class Receipt(val messageTimetoken: Long) : EventContent()
20

21    @Serializable
22    @SerialName("mention")
23    class Mention(val messageTimetoken: Long, val channel: String, val parentChannel: String? = null) : EventContent()
24    // channel should be channelId and parentChannel should be parentChannelId, but we can't change it not tt break compatibility with existing Chat SDK
25

26    @Serializable
27    @SerialName("invite")
28    class Invite(val channelType: ChannelType, val channelId: String) : EventContent()
29

30    @Serializable
31    @SerialName("custom")
32    class Custom(
33        @Contextual val data: Any,
34        @Transient val method: EmitEventMethod = EmitEventMethod.PUBLISH
35    ) : EventContent()
36

37    @Serializable
38    @SerialName("moderation")
39    class Moderation(val channelId: String, val restriction: RestrictionType, val reason: String? = null) :
40        EventContent()
41

42    @Serializable
43    @SerialName("text")
44    open class TextMessageContent(
45        val text: String,
46        val files: List<File>? = null,
47    ) : EventContent() {
48        override fun equals(other: Any?): Boolean {
49            if (this === other) {
50                return true
51            }
52            if (other !is TextMessageContent) {
53                return false
54            }
55

56            if (text != other.text) {
57                return false
58            }
59            if (files != other.files) {
60                return false
61            }
62

63            return true
64        }
65

66        override fun hashCode(): Int {
67            var result = text.hashCode()
68            result = 31 * result + (files?.hashCode() ?: 0)
69            return result
70        }
71

72        override fun toString(): String {
73            return "TextMessageContent(text='$text', files=$files)"
74        }
75    }
76

77    class UnknownMessageFormat(val jsonElement: JsonElement) : TextMessageContent("", null)
78}

show all 78 lines

For details, refer to the chat events documentation.

Event structure

Use case

Events enable:

• Collecting historical chat events
• Creating custom events
• Building moderation dashboards for flagged messages
• Triggering business logic with Functions