Realtime WebSocket Protocol
Chatto exposes realtime updates at GET /api/realtime using binary protobuf frames from chatto.realtime.v1.
Read the Realtime Protocol Overview before you implement the connection lifecycle, snapshot processing, event processing, targeted cursor-bounded reads, or reconnect behavior. Follow Use Realtime From TypeScript for a complete browser example.
This page separates protocol frames from the public event catalogue. The RealtimeEvent section lists every public event variant.
Realtime frames are documented separately from ConnectRPC services because they are exchanged over a long-lived WebSocket session rather than /api/connect RPC methods.
Protocol Frames
Section titled “Protocol Frames”These messages and enums control the WebSocket lifecycle, snapshots, recovery, liveness, errors, and closure.
RealtimeCaughtUp
Section titled “RealtimeCaughtUp”Confirms that recovery is complete and live delivery has begun.
Clients can retain cursor after they apply every preceding event.
| Field | Type | Description |
|---|---|---|
cursor | string | Opaque cursor at the recovery-to-live handoff boundary. |
recovery | RealtimeRecovery | Actual recovery result, including a successful replay with no events. |
RealtimeClose
Section titled “RealtimeClose”Close instruction sent before the socket closes when possible.
| Field | Type | Description |
|---|---|---|
code | RealtimeCloseCode | Stable machine-readable close code. |
message | string | Safe human-readable close message. |
reconnect | bool | Whether the client should reconnect automatically. |
retry_after | google.protobuf.Duration | Suggested delay before reconnect. |
RealtimeHeartbeat
Section titled “RealtimeHeartbeat”Application-level heartbeat.
| Field | Type | Description |
|---|---|---|
cursor | optional string | Fresh resume cursor for the latest replay boundary delivered on this socket. A client can retain it only after all earlier frames have been applied. |
RealtimeServerFrame
Section titled “RealtimeServerFrame”Server-to-client frame for Chatto’s protobuf WebSocket realtime protocol.
| Field | Type | Description |
|---|---|---|
frame.event | RealtimeEvent | One authorized public event copy. |
frame.heartbeat | RealtimeHeartbeat | Application-level heartbeat used for liveness checks. |
frame.close | RealtimeClose | Server-requested close with reconnect guidance. |
frame.caught_up | RealtimeCaughtUp | Confirms that recovery reached the live-stream boundary. |
frame.snapshot | RealtimeSnapshot | One exact authorized server-content snapshot. |
RealtimeSnapshot
Section titled “RealtimeSnapshot”One authorized snapshot of the current bounded server content.
The server sends at most one snapshot before caught_up. The client must
discard the snapshot if the socket closes before caught_up. List values
replace the complete local family.
Large and paginated resources, such as message history, are not part of the
snapshot and remain available through ConnectRPC.
| Field | Type | Description |
|---|---|---|
server | chatto.api.v1.ServerPublicProfile | Current public server profile. |
rooms | repeated chatto.api.v1.RoomWithViewerState | All rooms visible to the caller at the snapshot boundary. |
room_groups | repeated chatto.api.v1.RoomGroup | All room groups visible to the caller at the snapshot boundary. |
users | repeated chatto.api.v1.DirectoryMember | The viewer and public users referenced by another snapshot family. |
active_calls | repeated chatto.api.v1.ActiveCall | All active calls visible to the caller at the snapshot boundary. |
RealtimeSubscribe
Section titled “RealtimeSubscribe”Starts one authorized public realtime subscription.
The client sends this message as the first binary WebSocket message. The client does not send more application messages on the socket.
| Field | Type | Description |
|---|---|---|
protocol_version | uint32 | Behavioral protocol version requested by the client. The only supported version is 4. |
bearer_token | optional string | Optional bearer token. When present, it takes precedence over cookie auth. |
resume_cursor | optional string | Opaque cursor from a previously received replayable event or caught_up frame. A usable cursor receives bounded authorized events after that position. Cursors expire 15 minutes after issue. |
initial_state | RealtimeInitialState | Required fallback when the cursor is absent or cannot resume safely. |
RealtimeCloseCode
Section titled “RealtimeCloseCode”Stable server-requested close category.
| Name | Number | Description |
|---|---|---|
REALTIME_CLOSE_CODE_UNSPECIFIED | 0 | Invalid or unknown close code. |
REALTIME_CLOSE_CODE_INVALID_REQUEST | 1 | The subscription message is malformed or contains an invalid value. |
REALTIME_CLOSE_CODE_UNSUPPORTED_PROTOCOL | 2 | The requested behavioral protocol version is not supported. |
REALTIME_CLOSE_CODE_TEMPORARILY_UNAVAILABLE | 3 | The server cannot accept or continue a realtime session at present. |
REALTIME_CLOSE_CODE_AUTHENTICATION_REQUIRED | 4 | The caller is no longer authenticated. |
REALTIME_CLOSE_CODE_SESSION_RENEWAL_REQUIRED | 5 | The caller must renew its session before reconnecting. |
REALTIME_CLOSE_CODE_RESYNC_REQUIRED | 6 | The client must discard its cursor and synchronize current state again. |
REALTIME_CLOSE_CODE_SESSION_TERMINATED | 7 | The user’s session ended and the client must return to sign-in. |
REALTIME_CLOSE_CODE_PRIVILEGED_MODE_EXPIRED | 8 | Privileged mode expired. Reconnect and refresh effective viewer and room permissions. |
RealtimeInitialState
Section titled “RealtimeInitialState”Startup behavior when a subscription cannot resume from its cursor.
| Name | Number | Description |
|---|---|---|
REALTIME_INITIAL_STATE_UNSPECIFIED | 0 | Invalid value. The server rejects subscriptions that use it. |
REALTIME_INITIAL_STATE_LIVE_ONLY | 1 | Start at the current event boundary without sending current resources. |
REALTIME_INITIAL_STATE_SNAPSHOT | 2 | Send an exact authorized snapshot before later public events. |
RealtimeRecovery
Section titled “RealtimeRecovery”How the server reached the live-delivery boundary.
| Name | Number | Description |
|---|---|---|
REALTIME_RECOVERY_UNSPECIFIED | 0 | Invalid value. The server always supplies a recovery result. |
REALTIME_RECOVERY_RESUMED | 1 | The requested cursor was accepted and all available authorized events followed it. |
REALTIME_RECOVERY_SNAPSHOT | 2 | The server sent a replacement snapshot. |
REALTIME_RECOVERY_LIVE_ONLY | 3 | The server started at the current boundary without past events or resources. |
Event Catalogue
Section titled “Event Catalogue”These messages and enums define the authorized semantic events that the server can deliver. An event can contain a resume cursor when the server can replay it. Other events are cursorless.
RealtimeEvent
Section titled “RealtimeEvent”One authorized public event with its optional cursor.
Each payload uses a realtime-owned public message. The union is the public event catalogue. An internal event that is absent from this union is not part of the realtime API. The server creates a fresh caller-specific value after authorization. An event has a resume cursor when it can be replayed. An event without a cursor is safe to miss, or its state can be restored from a snapshot or a ConnectRPC resource.
| Field | Type | Description |
|---|---|---|
id | string | Universal event identifier (NanoID). |
created_at | google.protobuf.Timestamp | Time when the source event was created. |
actor_id | optional string | ID of the user that caused the event. Absence means no user actor. |
cursor | optional string | Opaque cursor safe to retain after this complete event is accepted. |
event.room_created | RoomCreatedEvent | No field description provided. |
event.room_updated | RoomUpdatedEvent | No field description provided. |
event.room_deleted | RoomDeletedEvent | No field description provided. |
event.room_archived | RoomArchivedEvent | No field description provided. |
event.room_unarchived | RoomUnarchivedEvent | No field description provided. |
event.room_universal_changed | RoomUniversalChangedEvent | No field description provided. |
event.room_slow_mode_changed | RoomSlowModeChangedEvent | No field description provided. |
event.room_threading_mode_changed | RoomThreadingModeChangedEvent | No field description provided. |
event.user_joined_room | UserJoinedRoomEvent | No field description provided. |
event.user_left_room | UserLeftRoomEvent | No field description provided. |
event.voice_call_participant_joined | VoiceCallParticipantJoinedEvent | No field description provided. |
event.voice_call_participant_left | VoiceCallParticipantLeftEvent | No field description provided. |
event.voice_call_started | VoiceCallStartedEvent | No field description provided. |
event.voice_call_ended | VoiceCallEndedEvent | No field description provided. |
event.message_posted | MessagePostedEvent | No field description provided. |
event.message_edited | MessageEditedEvent | No field description provided. |
event.message_retracted | MessageRetractedEvent | No field description provided. |
event.message_pinned | MessagePinnedEvent | No field description provided. |
event.message_unpinned | MessageUnpinnedEvent | No field description provided. |
event.thread_created | ThreadCreatedEvent | No field description provided. |
event.asset_processing_started | AssetProcessingStartedEvent | No field description provided. |
event.asset_processing_succeeded | AssetProcessingSucceededEvent | No field description provided. |
event.asset_processing_failed | AssetProcessingFailedEvent | No field description provided. |
event.asset_deleted | AssetDeletedEvent | No field description provided. |
event.server_motd_changed | ServerMotdChangedEvent | No field description provided. |
event.user_account_created | UserAccountCreatedEvent | No field description provided. |
event.user_profile_changed | UserProfileChangedEvent | No field description provided. |
event.user_account_deleted | UserAccountDeletedEvent | No field description provided. |
event.reaction_added | ReactionAddedEvent | No field description provided. |
event.reaction_removed | ReactionRemovedEvent | No field description provided. |
event.viewer_preferences_changed | ViewerPreferencesChangedEvent | No field description provided. |
event.thread_viewer_state_changed | ThreadViewerStateChangedEvent | No field description provided. |
event.server_profile_changed | ServerProfileChangedEvent | No field description provided. |
event.user_typing | UserTypingEvent | No field description provided. |
event.presence_changed | PresenceChangedEvent | No field description provided. |
event.notification_occurrences_changed | NotificationOccurrencesChangedEvent | No field description provided. |
event.notification_unread_state_changed | NotificationUnreadStateChangedEvent | No field description provided. |
event.room_read_state_changed | RoomReadStateChangedEvent | No field description provided. |
event.room_layout_changed | RoomLayoutChangedEvent | No field description provided. |
event.role_created | RoleCreatedEvent | No field description provided. |
event.role_updated | RoleUpdatedEvent | No field description provided. |
event.role_deleted | RoleDeletedEvent | No field description provided. |
event.roles_reordered | RolesReorderedEvent | No field description provided. |
event.role_assigned | RoleAssignedEvent | No field description provided. |
event.role_revoked | RoleRevokedEvent | No field description provided. |
event.role_permissions_changed | RolePermissionsChangedEvent | No field description provided. |
event.viewer_permissions_changed | ViewerPermissionsChangedEvent | No field description provided. |
event.viewer_presence_preference_changed | ViewerPresencePreferenceChangedEvent | No field description provided. |
event.room_invitation_created | RoomInvitationCreatedEvent | No field description provided. |
event.room_invitation_accepted | RoomInvitationAcceptedEvent | No field description provided. |
event.room_invitation_declined | RoomInvitationDeclinedEvent | No field description provided. |
event.room_notice_changed | RoomNoticeChangedEvent | No field description provided. |
event.user_account_deactivation_changed | UserAccountDeactivationChangedEvent | No field description provided. |
event.room_membership_events_visibility_changed | RoomMembershipEventsVisibilityChangedEvent | No field description provided. |
AllMessageMention
Section titled “AllMessageMention”AllMessageMention identifies a room-wide mention.
AssetDeletedEvent
Section titled “AssetDeletedEvent”AssetDeletedEvent reports a deleted asset.
| Field | Type | Description |
|---|---|---|
asset_id | string | No field description provided. |
room_id | string | Room containing the affected message. |
message_event_id | string | Message that owns the asset, including a deleted derivative asset. |
AssetProcessingFailedEvent
Section titled “AssetProcessingFailedEvent”AssetProcessingFailedEvent reports failed message-asset processing.
| Field | Type | Description |
|---|---|---|
asset_id | string | No field description provided. |
failure_code | AssetProcessingFailureCode | No field description provided. |
message_event_id | string | No field description provided. |
room_id | string | Room containing the affected message. |
AssetProcessingStartedEvent
Section titled “AssetProcessingStartedEvent”AssetProcessingStartedEvent reports that message-asset processing started.
| Field | Type | Description |
|---|---|---|
asset_id | string | No field description provided. |
message_event_id | string | No field description provided. |
room_id | string | Room containing the affected message. |
AssetProcessingSucceededEvent
Section titled “AssetProcessingSucceededEvent”AssetProcessingSucceededEvent reports successful message-asset processing. Read the message resource for current attachments and processed video data.
| Field | Type | Description |
|---|---|---|
asset_id | string | No field description provided. |
message_event_id | string | No field description provided. |
room_id | string | Room containing the affected message. |
DirectUserMention
Section titled “DirectUserMention”DirectUserMention identifies a direct user mention.
| Field | Type | Description |
|---|---|---|
user_id | string | No field description provided. |
HereMessageMention
Section titled “HereMessageMention”HereMessageMention identifies a presence-scoped mention.
MessageEditedEvent
Section titled “MessageEditedEvent”MessageEditedEvent reports changed message content or metadata.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
message_event_id | string | No field description provided. |
MessageMention
Section titled “MessageMention”MessageMention identifies one distinct mention target. Role, here, and all targets occur once, regardless of the number of recipients. Targets with no resolved recipients are omitted. Recipient decisions are from message creation, including during replay; clients must not infer them from current membership.
| Field | Type | Description |
|---|---|---|
cause.direct | DirectUserMention | No field description provided. |
cause.role | RoleMessageMention | No field description provided. |
cause.here | HereMessageMention | No field description provided. |
cause.all | AllMessageMention | No field description provided. |
includes_viewer | bool | True if this target included the authenticated caller when the message was posted. |
MessagePinnedEvent
Section titled “MessagePinnedEvent”MessagePinnedEvent reports a newly pinned message.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
message_event_id | string | No field description provided. |
MessagePostedEvent
Section titled “MessagePostedEvent”MessagePostedEvent reports a new room message.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
in_reply_to | string | No field description provided. |
thread_root_event_id | string | Root message ID for a thread reply. Empty for a room-level message. |
echo_of_event_id | string | No field description provided. |
echo_from_thread_root_event_id | string | No field description provided. |
mentions | repeated MessageMention | Distinct mention targets, without expanded role or broadcast recipients. |
body_plaintext | optional string | Plaintext message text. The field is absent after key shredding. |
room_kind | chatto.api.v1.RoomKind | Immutable room kind. Direct messages do not require a mention to address a bot. |
MessageRetractedEvent
Section titled “MessageRetractedEvent”MessageRetractedEvent reports a retracted message.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
message_event_id | string | No field description provided. |
MessageUnpinnedEvent
Section titled “MessageUnpinnedEvent”MessageUnpinnedEvent reports a message that is no longer pinned.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
message_event_id | string | No field description provided. |
NotificationOccurrencesChangedEvent
Section titled “NotificationOccurrencesChangedEvent”NotificationOccurrencesChangedEvent reports that the caller’s current notification occurrences changed and requests an authoritative resource read.
| Field | Type | Description |
|---|---|---|
created_notification_id | optional string | ID of a newly created notification, including read notifications and creations during Do Not Disturb. Absent for updates and removals. This is a best-effort live hint, not a sound instruction or durable delivery. Clients decide whether to alert after they read current notification state. |
NotificationUnreadStateChangedEvent
Section titled “NotificationUnreadStateChangedEvent”NotificationUnreadStateChangedEvent reports that the caller’s notification unread state changed and requests authoritative notification and room reads.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
thread_root_event_id | string | Event ID of the affected thread root, or empty for room state. |
PresenceChangedEvent
Section titled “PresenceChangedEvent”PresenceChangedEvent reports the actor’s current presence.
| Field | Type | Description |
|---|---|---|
status | chatto.api.v1.PresenceStatus | No field description provided. |
ReactionAddedEvent
Section titled “ReactionAddedEvent”ReactionAddedEvent reports a new message reaction.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
message_event_id | string | No field description provided. |
emoji | string | No field description provided. |
ReactionRemovedEvent
Section titled “ReactionRemovedEvent”ReactionRemovedEvent reports a removed message reaction.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
message_event_id | string | No field description provided. |
emoji | string | No field description provided. |
RoleAssignedEvent
Section titled “RoleAssignedEvent”A user was assigned a role. The named user’s clients must discard private cached data and load current authorized state. Other viewers update member role lists without a full reload.
| Field | Type | Description |
|---|---|---|
user_id | string | User whose assignment changed. |
role_name | string | Stable role name. |
RoleCreatedEvent
Section titled “RoleCreatedEvent”A public role was created. Read its current metadata with RoleService.
| Field | Type | Description |
|---|---|---|
role_name | string | Stable role name. |
RoleDeletedEvent
Section titled “RoleDeletedEvent”A role was deleted. Remove it from role catalogues and member role lists. Clients retaining this role for their viewer must discard private cached data and load current authorized state before displaying it again.
| Field | Type | Description |
|---|---|---|
role_name | string | Stable name of the deleted role. |
RoleMessageMention
Section titled “RoleMessageMention”RoleMessageMention identifies the role that caused a mention.
| Field | Type | Description |
|---|---|---|
role_name | string | No field description provided. |
RolePermissionsChangedEvent
Section titled “RolePermissionsChangedEvent”A role’s permission decisions changed. Clients whose viewer has this role must discard private cached data and load current authorized state. The implicit everyone role applies to every viewer. Private scopes and permission decisions are not included. Read current decisions through authorized APIs.
| Field | Type | Description |
|---|---|---|
role_name | string | Stable role name. |
RoleRevokedEvent
Section titled “RoleRevokedEvent”A user’s role assignment was removed. The named user’s clients must discard private cached data and load current authorized state.
| Field | Type | Description |
|---|---|---|
user_id | string | User whose assignment changed. |
role_name | string | Stable role name. |
RoleUpdatedEvent
Section titled “RoleUpdatedEvent”Public role metadata changed. Read its current metadata with RoleService. This event does not change permission decisions.
| Field | Type | Description |
|---|---|---|
role_name | string | Stable role name. |
RolesReorderedEvent
Section titled “RolesReorderedEvent”Custom roles changed display order. Permission decisions are unchanged.
| Field | Type | Description |
|---|---|---|
role_names | repeated string | Custom role names in ascending display position. |
RoomArchivedEvent
Section titled “RoomArchivedEvent”RoomArchivedEvent reports a room that became archived.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
RoomCreatedEvent
Section titled “RoomCreatedEvent”RoomCreatedEvent reports a new room that is visible to the caller.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
name | string | No field description provided. |
description | string | No field description provided. |
kind | chatto.api.v1.RoomKind | No field description provided. |
universal | bool | No field description provided. |
threading_mode | chatto.api.v1.RoomThreadingMode | No field description provided. |
RoomDeletedEvent
Section titled “RoomDeletedEvent”RoomDeletedEvent reports a deleted room.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
RoomInvitationAcceptedEvent
Section titled “RoomInvitationAcceptedEvent”An invitation accepted. Delivered only to its sender and recipient.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
invitation_id | string | No field description provided. |
RoomInvitationCreatedEvent
Section titled “RoomInvitationCreatedEvent”An invitation created. Delivered only to its sender and recipient.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
invitation_id | string | No field description provided. |
RoomInvitationDeclinedEvent
Section titled “RoomInvitationDeclinedEvent”An invitation declined. Delivered only to its sender and recipient.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
invitation_id | string | No field description provided. |
RoomLayoutChangedEvent
Section titled “RoomLayoutChangedEvent”RoomLayoutChangedEvent reports a change to room groups, their entries, or order. Refresh RoomDirectoryService.ListRoomGroups with this event’s cursor as the minimum boundary. The event contains no room IDs or other hidden layout data.
RoomMembershipEventsVisibilityChangedEvent
Section titled “RoomMembershipEventsVisibilityChangedEvent”RoomMembershipEventsVisibilityChangedEvent changes how clients display room join/leave activity, including history. Clients must still process membership events when this setting is false.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
show_membership_events | bool | No field description provided. |
RoomNoticeChangedEvent
Section titled “RoomNoticeChangedEvent”RoomNoticeChangedEvent asks current room members to read the latest notice. It covers corrections, publication, republishing, and clear operations.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
RoomReadStateChangedEvent
Section titled “RoomReadStateChangedEvent”RoomReadStateChangedEvent reports the caller’s current room read state.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
RoomSlowModeChangedEvent
Section titled “RoomSlowModeChangedEvent”RoomSlowModeChangedEvent reports the current slow-mode interval.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
slow_mode_seconds | uint32 | No field description provided. |
thread_slow_mode_seconds | optional uint32 | Independent interval within each thread. Zero disables it. |
RoomThreadingModeChangedEvent
Section titled “RoomThreadingModeChangedEvent”RoomThreadingModeChangedEvent reports the current room threading policy.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
threading_mode | chatto.api.v1.RoomThreadingMode | No field description provided. |
RoomUnarchivedEvent
Section titled “RoomUnarchivedEvent”RoomUnarchivedEvent reports a room that became active again.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
RoomUniversalChangedEvent
Section titled “RoomUniversalChangedEvent”RoomUniversalChangedEvent reports the current universal-membership setting.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
universal | bool | No field description provided. |
RoomUpdatedEvent
Section titled “RoomUpdatedEvent”RoomUpdatedEvent reports changed room metadata.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
name | string | No field description provided. |
description | string | No field description provided. |
ServerMotdChangedEvent
Section titled “ServerMotdChangedEvent”ServerMotdChangedEvent reports the current message of the day.
| Field | Type | Description |
|---|---|---|
motd | string | No field description provided. |
ServerProfileChangedEvent
Section titled “ServerProfileChangedEvent”ServerProfileChangedEvent reports that the public server profile changed. Read ServerService with this event’s resume cursor as the minimum boundary.
ThreadCreatedEvent
Section titled “ThreadCreatedEvent”ThreadCreatedEvent reports a new message thread.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
thread_root_event_id | string | No field description provided. |
ThreadViewerStateChangedEvent
Section titled “ThreadViewerStateChangedEvent”ThreadViewerStateChangedEvent reports the caller’s current thread state.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
thread_root_event_id | string | No field description provided. |
is_following | bool | No field description provided. |
UserAccountCreatedEvent
Section titled “UserAccountCreatedEvent”UserAccountCreatedEvent reports a new public user account.
| Field | Type | Description |
|---|---|---|
user_id | string | No field description provided. |
is_bot | bool | No field description provided. |
UserAccountDeactivationChangedEvent
Section titled “UserAccountDeactivationChangedEvent”Reports a reversible account access change. Administrative details are private.
| Field | Type | Description |
|---|---|---|
user_id | string | No field description provided. |
deactivated | bool | No field description provided. |
UserAccountDeletedEvent
Section titled “UserAccountDeletedEvent”UserAccountDeletedEvent reports a deleted user account.
| Field | Type | Description |
|---|---|---|
user_id | string | No field description provided. |
UserJoinedRoomEvent
Section titled “UserJoinedRoomEvent”UserJoinedRoomEvent reports that the actor joined a room.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
UserLeftRoomEvent
Section titled “UserLeftRoomEvent”UserLeftRoomEvent reports that the actor left a room.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
UserProfileChangedEvent
Section titled “UserProfileChangedEvent”UserProfileChangedEvent reports that the current public user resource changed. Read the user through UserService with this event’s resume cursor as the minimum boundary.
| Field | Type | Description |
|---|---|---|
user_id | string | No field description provided. |
UserTypingEvent
Section titled “UserTypingEvent”UserTypingEvent reports current typing activity for the event actor. Track each actor separately for each room and thread. Clear the indicator 6 seconds after the last received typing event, or when that actor posts a message in the same room or thread. No stop-typing event is sent.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
thread_root_event_id | optional string | No field description provided. |
ViewerPermissionsChangedEvent
Section titled “ViewerPermissionsChangedEvent”The authenticated viewer’s permission decisions may have changed. This also covers changes to a bot’s owner permission ceiling. Delivered only to the affected viewer. Discard private cached data and load current authorized state before displaying it again. The connection itself remains open.
ViewerPreferencesChangedEvent
Section titled “ViewerPreferencesChangedEvent”ViewerPreferencesChangedEvent reports that the caller’s private user preferences changed. Read ViewerService with this event’s resume cursor as the minimum boundary.
ViewerPresencePreferenceChangedEvent
Section titled “ViewerPresencePreferenceChangedEvent”Delivered only to the account whose private availability choice changed. Refetch MyAccountService.GetPresencePreference to obtain the current choice.
VoiceCallEndedEvent
Section titled “VoiceCallEndedEvent”VoiceCallEndedEvent reports the end of a call session.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
call_id | string | No field description provided. |
VoiceCallParticipantJoinedEvent
Section titled “VoiceCallParticipantJoinedEvent”VoiceCallParticipantJoinedEvent reports that the actor joined a call session.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
call_id | string | No field description provided. |
VoiceCallParticipantLeftEvent
Section titled “VoiceCallParticipantLeftEvent”VoiceCallParticipantLeftEvent reports that the actor left a call session.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
call_id | string | No field description provided. |
VoiceCallStartedEvent
Section titled “VoiceCallStartedEvent”VoiceCallStartedEvent reports a new call session.
| Field | Type | Description |
|---|---|---|
room_id | string | No field description provided. |
call_id | string | No field description provided. |
AssetProcessingFailureCode
Section titled “AssetProcessingFailureCode”AssetProcessingFailureCode identifies a stable processing failure class.
| Name | Number | Description |
|---|---|---|
ASSET_PROCESSING_FAILURE_CODE_UNSPECIFIED | 0 | The failure class is not known. |
ASSET_PROCESSING_FAILURE_CODE_PROCESSING_FAILED | 1 | Asset processing failed without a more specific public reason. |
ASSET_PROCESSING_FAILURE_CODE_SOURCE_MISSING | 2 | The source asset was not available. |