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:

1public protocol Event<T> {
2  associatedtype C: Chat
3  associatedtype T: EventContent
4  
5  var chat: C { get }
6  var timetoken: Timetoken { get }
7  var payload: T { get }
8  var channelId: String { get }
9  var userId: String { get }
10}

Parameter	Description
chat Type: C	Reference to the main ChatImpl object.
timetoken Type: Timetoken	Timetoken of the message that triggered an event.
payload Type: T	Data passed in an event. For custom events, this is EventContent.Custom with a data: [String: Any] dictionary. Entity-specific events are delivered via dedicated callbacks (onTypingChanged(), onMessageReported(), onReadReceiptReceived(), onMentioned(), onInvited(), onRestrictionChanged()) rather than through this property.
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 has the following active subtypes:

1public class EventContent {
2

3  // MARK: - Custom
4

5  public class Custom: EventContent {
6    public let data: [String: Any]
7    public let method: EmitEventMethod
8

9    public init(data: [String : Any], method: EmitEventMethod) {
10      self.data = data
11      self.method = method
12    }
13  }
14

15  // MARK: - TextMessageContent
16

17  public class TextMessageContent: EventContent {
18    public let text: String
19    public let files: [File]?
20

21    public init(text: String, files: [File]? = nil) {
22      self.text = text
23      self.files = files
24    }
25  }
26

27  // MARK: - UnknownMessageFormat
28

29  public class UnknownMessageFormat: EventContent {
30    public let element: Any?
31

32    public init(element: Any? = nil) {
33      self.element = element
34    }
35  }
36}

show all 36 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