For AI agents: this page in Markdown: https://www.pubnub.com/docs/chat/unreal-chat-sdk/learn/chat-entities/event.md. Documentation index: https://www.pubnub.com/llms-full.txt.
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 object has the following properties:
Timetoken#- Timetoken of the message that triggered an event.
Type#- Type of action that emits an event:
PCET_Typing,PCET_Report,PCET_Receipt,PCET_Mention,PCET_Invite,PCET_Custom,PCET_Moderation. ChannelID#- Target channel where this event is delivered.
Payload#- Data passed in an event that differ depending on the event type.
For details, refer to the chat events documentation.
Use case
Events enable:
- Collecting historical chat events
- Creating custom events
- Building moderation dashboards for flagged messages
- Triggering business logic with Functions