Event object

An object that refers to a single piece of information emitted when someone is typing, receiving a message, mentioning others in a message, or reporting a message/user to the admin.

Contrary to other Chat SDK entities, this object provides no methods. Its only purpose is to pass payloads of different types emitted when certain chat operations occur.

Properties

The Event interface has the following properties:

class Event<T : EventContent>(
val chat: Chat,
val timetoken: Long,
val payload: T,
val channelId: String,
val userId: String
)
ParameterTypeDescription
chatChatReference to the main Chat object.
timetokenLongTimetoken of the message that triggered an event.
payloadTData passed in an event (of EventContent subtype) that differ depending on the emitted event type (typing, report, receipt, mention, invite, custom, moderation, or text).
channelIdStringTarget channel where this event is delivered.
userIdStringUnique ID of the user that triggered the event.
icon

Event structure

Use case

You can use events to collect historical chat events or create your own custom events. You can later visualize them in a graphical form (like a moderation dashboard for flagged users and messages) or create additional business logic with functions that these events can trigger.

Last updated on
On this page