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 (of EventContent subtype) that differ depending on the emitted event type (Typing, Report, Receipt, Mention, Invite, Custom, or Moderation).
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

2public class EventContent {
3  
4  // MARK: - Report
5  
6  public class Report: EventContent {
7    public let text: String?
8    public let reason: String
9    public let reportedMessageTimetoken: Timetoken?
10    public let reportedMessageChannelId: String?
11    public let reportedUserId: String?
12    
13    public init(
14      text: String? = nil,
15      reason: String,
16      reportedMessageTimetoken: Timetoken? = nil,
17      reportedMessageChannelId: String? = nil,
18      reportedUserId: String? = nil
19    ) {
20      self.text = text
21      self.reason = reason
22      self.reportedMessageTimetoken = reportedMessageTimetoken
23      self.reportedMessageChannelId = reportedMessageChannelId
24      self.reportedUserId = reportedUserId
25    }
26  }
27  
28  // MARK: - Typing
29  
30  public class Typing: EventContent {
31    public let value: Bool
32    
33    public init(value: Bool) {
34      self.value = value
35    }
36  }
37  
38  // MARK: - Receipt
39  
40  public class Receipt: EventContent {
41    public let messageTimetoken: Timetoken
42    
43    public init(messageTimetoken: Timetoken) {
44      self.messageTimetoken = messageTimetoken
45    }
46  }
47  
48  // MARK: - Mention
49  
50  public class Mention: EventContent {
51    public let messageTimetoken: Timetoken
52    public let channel: String
53    public let parentChannel: String?
54    
55    public init(messageTimetoken: Timetoken, channel: String, parentChannel: String? = nil) {
56      self.messageTimetoken = messageTimetoken
57      self.channel = channel
58      self.parentChannel = parentChannel
59    }
60  }
61  
62  // MARK: - Invite
63  
64  public class Invite: EventContent {
65    public let channelType: ChannelType
66    public let channelId: String
67    
68    public init(channelType: ChannelType, channelId: String) {
69      self.channelType = channelType
70      self.channelId = channelId
71    }
72  }
73  
74  // MARK: - Custom
75  
76  public class Custom: EventContent {
77    public let data: [String: Any]
78    public let method: EmitEventMethod
79    
80    public init(data: [String : Any], method: EmitEventMethod) {
81      self.data = data
82      self.method = method
83    }
84  }
85  
86  // MARK: - Moderation
87  
88  public class Moderation: EventContent {
89    public let channelId: String
90    public let restriction: RestrictionType
91    public let reason: String?
92    
93    public init(channelId: String, restriction: RestrictionType, reason: String?) {
94      self.channelId = channelId
95      self.restriction = restriction
96      self.reason = reason
97    }
98  }
99  
100  // MARK: - TextMessageContent
101  
102  public class TextMessageContent: EventContent {
103    public let text: String
104    public let files: [File]?
105    
106    public init(text: String, files: [File]? = nil) {
107      self.text = text
108      self.files = files
109    }
110  }
111  
112  // MARK: - UnknownMessageFormat
113  
114  public class UnknownMessageFormat: EventContent {
115    public let element: Any?
116    
117    public init(element: Any? = nil) {
118      self.element = element
119    }
120  }
121}

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