Shared Types And Enums
Shared message and enum definitions used by the ConnectRPC service pages.
Supporting Types
Section titled “Supporting Types”PendingExternalIdentity
Section titled “PendingExternalIdentity”Metadata about a pending external identity flow. The provider subject is not exposed; clients only need user-facing provider/profile hints.
| Field | Type | Description |
|---|---|---|
kind | ExternalIdentityFlowKind | Pending flow kind. |
provider_id | string | Provider ID that produced the identity. |
provider_type | string | Provider type that produced the identity. |
provider_label | string | Provider label shown to the user. |
verified_email | string | Verified email supplied by the provider, when available. |
login_hint | string | Suggested username derived from provider profile hints. |
display_name_hint | string | Suggested display name derived from provider profile hints. |
bound_user_id | string | User ID this link flow is bound to. Empty for create flows. |
redirect_path | string | Internal path the client should return to after confirmation. |
choose_username | optional UsernameChoiceAvailability | Whether the user can choose a username. When externally managed, the server assigns it and ignores client input. The login hint is not a reservation. |
invitation_required | bool | A create flow must first supply an invitation code. Existing-account sign-in is unaffected. |
NeighborhoodServer
Section titled “NeighborhoodServer”One server in the Neighborhood of the called server.
| Field | Type | Description |
|---|---|---|
origin | string | Canonical origin of the server. |
profile | chatto.api.v1.ServerPublicProfile | Public profile that the called server loaded. The welcome message is absent. The logo and banner URLs are server-relative paths of copies on the called server. Resolve them against the origin of the called server. |
direct_neighbor | bool | Whether the called server advertises this server as a Neighbor. |
recommended_by_origins | repeated string | Canonical origins of other servers in the same response that mutually recommend this server. The list does not include the called server. |
ServerFeature
Section titled “ServerFeature”A product feature that an older frontend can describe without knowing its implementation. This is upgrade guidance, not permission, configuration, API negotiation, or a minimum version required to connect.
| Field | Type | Description |
|---|---|---|
id | string | Stable feature identifier. Clients must accept previously unknown IDs. |
name | string | Localised display name. Render as plain text, never HTML or Markdown. |
description | string | Localised explanation for users. Render as plain text. |
introduced_version | string | First Chatto release with support for this feature in the server and bundled frontend. Third-party clients use the ID with their own support policy instead. |
PageInfo
Section titled “PageInfo”Offset-based page metadata returned by list RPCs.
| Field | Type | Description |
|---|---|---|
total_count | int64 | Total matching item count before pagination. |
has_more | bool | True when another page exists after this response. |
PageRequest
Section titled “PageRequest”Offset-based page request for list RPCs whose result order is stable enough for simple list browsing. Pages are live reads, not a fixed snapshot. Changes between requests can shift offsets.
| Field | Type | Description |
|---|---|---|
limit | int32 | Maximum number of items to request. Each RPC defines its default and effective maximum. Valid values above that maximum are capped. This shared shape rejects values above 500 or below zero. Zero uses the RPC default. |
offset | int32 | Zero-based number of matching items to skip. |
Public role metadata used for rendering role mentions, labels, and catalogs.
| Field | Type | Description |
|---|---|---|
name | string | Stable role name used in permission and assignment records. |
display_name | string | Display name shown in user-facing role UIs. |
description | string | Optional role description. |
is_system | bool | Whether this is a built-in role. |
position | int32 | Display/order position. |
pingable | bool | Whether messages may notify users assigned to this role. |
PresencePreference
Section titled “PresencePreference”Saved choice visible only to the authenticated account itself.
| Field | Type | Description |
|---|---|---|
status | PresenceStatus | Saved choice, independent of liveness. OFFLINE means “Appear Offline”; DO_NOT_DISTURB suppresses alerts even while disconnected. |
revision | string | Opaque revision required when replacing this choice. |
CustomUserStatus
Section titled “CustomUserStatus”Custom status shown on a user profile, separate from presence.
| Field | Type | Description |
|---|---|---|
emoji | string | Short emoji marker displayed with the status. |
text | string | User-written status text. |
expires_at | google.protobuf.Timestamp | Optional time after which clients should stop showing the status. |
BotInfo
Section titled “BotInfo”Public metadata for a bot account. Presence on User identifies a bot. Credentials and management-only details belong to the managed Bot resource.
| Field | Type | Description |
|---|---|---|
owner_user_id | string | Human account that owns this bot; this identity does not grant management access. |
Public user fields.
| Field | Type | Description |
|---|---|---|
id | string | Stable user ID. |
login | string | Login name. |
display_name | string | Display name, when set. |
deleted | bool | True when the user account has been deleted. |
avatar_url | optional string | Avatar image URL, when available. |
presence_status | PresenceStatus | Current live presence status. |
custom_status | CustomUserStatus | Custom profile status, when set. |
bio | optional string | Short Markdown biography shown on the user’s profile, when set. |
timezone | optional string | IANA time zone the user chose to share on their profile (for example “Europe/Berlin”). Absent means the user has not enabled time-zone sharing or has no stored time zone. |
bot | BotInfo | Present for a bot identity; absent for humans and deleted-account references. |
deactivated | bool | True while the account cannot use this server. Data is retained and access can be restored. |
CapabilityGrant
Section titled “CapabilityGrant”Effective decision for one capability key.
Built-in keys currently include:
- admin.view
- dm.start
- admin.view-users
- user.manage-accounts
- user.manage-invites
- role.assign
- role.view
- role.manage
- admin.view-system
- admin.view-audit
- user.manage-permissions
Clients should ignore unknown keys so servers can add capabilities over time.
| Field | Type | Description |
|---|---|---|
capability | string | Stable capability key, such as “admin.view” or “dm.start”. |
granted | bool | Whether the capability is currently available. |
EffectivePermission
Section titled “EffectivePermission”A permission currently allowed at a scope. Membership and action-specific requirements still apply. This is effective authority, not a stored grant.
| Field | Type | Description |
|---|---|---|
permission | string | Stable permission identifier. |
scope | EffectivePermissionScope | Scope where the permission is allowed. |
covers_descendants | bool | True when every applicable child scope also allows this permission. Hidden rooms participate in this check without revealing their identities. False means clients must not describe this grant as covering all children. |
EffectivePermissionScope
Section titled “EffectivePermissionScope”Scope metadata visible to the caller.
| Field | Type | Description |
|---|---|---|
kind | EffectivePermissionScopeKind | Scope tier. |
id | string | Room or group ID; empty for server and DM scopes. |
name | string | Current room or group name; empty for server and DM scopes. |
parent_group_id | string | Parent group ID for a channel room; empty for other scopes. |
PermissionGrant
Section titled “PermissionGrant”Effective decision for one permission key.
| Field | Type | Description |
|---|---|---|
permission | string | Stable permission key, such as “server.manage”. |
granted | bool | Whether the permission is currently granted. |
RoomInvitation
Section titled “RoomInvitation”An invitation visible only to its sender and recipient.
| Field | Type | Description |
|---|---|---|
id | string | No field description provided. |
room_id | string | No field description provided. |
sender_id | string | No field description provided. |
recipient_id | string | No field description provided. |
created_at | google.protobuf.Timestamp | No field description provided. |
expires_at | google.protobuf.Timestamp | No field description provided. |
status | RoomInvitationStatus | No field description provided. |
can_accept | bool | True only for the recipient while current room and sender rules permit acceptance. |
ImageTransformOptions
Section titled “ImageTransformOptions”Image transform parameters for generated image URLs.
| Field | Type | Description |
|---|---|---|
width | int32 | Target image width in pixels. |
height | int32 | Target image height in pixels. |
fit | ImageFitMode | Image crop/fit behavior. |
ImageUpload
Section titled “ImageUpload”Browser-supplied image upload payload.
| Field | Type | Description |
|---|---|---|
image | bytes | Raw image bytes. |
filename | string | Original browser filename, for diagnostics and future compatibility. |
content_type | string | Browser-provided content type, for diagnostics and future compatibility. |
ProviderMetadata
Section titled “ProviderMetadata”Public login/provider metadata shared by discovery and account-linking APIs.
| Field | Type | Description |
|---|---|---|
id | string | Stable configured provider ID. |
type | string | Provider type, such as “password”, “oidc”, “github”, or “discord”. |
label | string | Human-readable provider label. |
login_url | string | URL that starts login for this provider. |
issuer_url | optional string | OIDC issuer URL. Absent for providers that do not use OpenID Connect. Clients can compare this value with their own trusted issuer selection; the server does not select the client’s identity provider. |
auto_provision | optional bool | Whether an unlinked identity may create a new account through this provider. |
LinkPreview
Section titled “LinkPreview”Link preview metadata used by message composers and room timeline events.
Clients should treat optional metadata as unavailable when absent. Message creation accepts only the preview_token returned by FetchLinkPreview, not client-provided metadata fields.
| Field | Type | Description |
|---|---|---|
url | string | Previewed URL. |
title | optional string | Page or embed title. |
description | optional string | Page or embed description. |
image_url | optional string | Preview image URL, when available. |
image_asset_id | optional string | Existing server asset ID for the preview image, when cached or stored with the message. |
site_name | optional string | Site name, when known. |
embed_type | optional string | Embed provider or type, when recognized. |
embed_id | optional string | Provider-specific embed ID, when recognized. |
social_post | SocialPostPreview | Structured, provider-neutral social-post data for native rendering. |
SocialPostAuthor
Section titled “SocialPostAuthor”Author shown on a social-post preview.
| Field | Type | Description |
|---|---|---|
display_name | string | Author display name. |
handle | string | Provider-native handle without a leading at-sign when applicable. |
avatar_url | optional string | Locally served author avatar URL, when available. |
avatar_asset_id | optional string | Locally stored author avatar asset ID, when available. |
SocialPostExternalLink
Section titled “SocialPostExternalLink”Website card embedded in a social post.
| Field | Type | Description |
|---|---|---|
url | string | Destination URL. |
title | optional string | Card title, when available. |
description | optional string | Card description, when available. |
image_url | optional string | Locally served card image URL, when available. |
image_asset_id | optional string | Locally stored card image asset ID, when available. |
SocialPostImage
Section titled “SocialPostImage”One image attached directly to a social post.
| Field | Type | Description |
|---|---|---|
url | string | Locally served image URL. |
asset_id | string | Locally stored image asset ID. |
alt | optional string | Author-provided alternative text. |
width | optional uint32 | Source aspect-ratio width, when known. |
height | optional uint32 | Source aspect-ratio height, when known. |
SocialPostPreview
Section titled “SocialPostPreview”Bounded, provider-neutral social-post data used for native preview cards.
| Field | Type | Description |
|---|---|---|
provider | string | Stable lowercase provider identifier, such as “bluesky”. |
author | SocialPostAuthor | Author shown on the post. |
text | string | Plain-text post body. |
published_at | google.protobuf.Timestamp | Post publication time. |
images | repeated SocialPostImage | Images attached directly to the post, in display order. |
external_link | SocialPostExternalLink | Website card embedded in the post, when present. |
content_warning | optional string | Provider-supplied content warning, when present. |
url | string | Canonical URL for this post. Always set for quoted posts; the outer post may also use LinkPreview.url. |
quoted_post | SocialPostPreview | Post quoted by this post, when present. Quotes inside this snapshot are omitted so preview size and rendering depth remain bounded. |
Message
Section titled “Message”Renderable message data.
The same shape is used for top-level room messages, thread replies, and thread echo entries. Thread-related fields let clients render reply counts, thread participants, and follow state without additional per-message requests.
| Field | Type | Description |
|---|---|---|
id | string | Stable message event ID. |
room_id | string | Room containing the message. |
created_at | google.protobuf.Timestamp | Time when the message was created. |
actor_id | string | User ID of the message actor. |
body | optional string | Message body text, when available. A present empty string is distinct from an absent body. |
attachments | repeated MessageAttachment | Attachments sent with the message. |
link_preview | LinkPreview | Link preview extracted for the message, when available. |
updated_at | google.protobuf.Timestamp | Time when the message was last edited. |
in_reply_to | string | Event ID this message directly replies to, when this is a reply. |
thread_root_event_id | string | Event ID of the root message for the thread this message belongs to. |
echo_of_event_id | string | Event ID this event echoes into the current view, when applicable. Echoes allow thread activity to appear in another timeline context. |
echo_from_thread_root_event_id | string | Thread root ID of the echoed event, when applicable. |
channel_echo_event_id | string | Channel timeline event ID for a thread echo, when applicable. |
reactions | repeated MessageReaction | Reaction summaries for this message. |
thread | ThreadSummary | Aggregated thread state. Present only when a durable thread has been established for this root message, including an empty thread. |
deleted_at | google.protobuf.Timestamp | Time when the message content was deleted through retraction or account crypto-shredding. Absent when unavailable body content is not a deletion. |
pinned | bool | True when this message’s canonical message is currently pinned in its channel room. Always false for direct-message rooms. |
viewer_state | MessageViewerState | State resolved for the current viewer. Available even before a durable thread exists. Absent when viewer state has not been resolved. |
MessageAssetUrl
Section titled “MessageAssetUrl”Time-limited URL for an asset attached to a message.
Clients should expect these URLs to expire and refresh the asset through AssetService when a URL is no longer usable.
| Field | Type | Description |
|---|---|---|
url | string | Signed asset URL. |
expires_at | google.protobuf.Timestamp | Time when the signed URL expires. |
MessageAttachment
Section titled “MessageAttachment”Attachment metadata included with a message.
Image and video dimensions are best-effort metadata for layout. Asset URLs can be absent while processing is pending or when the source is unavailable.
| Field | Type | Description |
|---|---|---|
id | string | Stable attachment ID. |
filename | string | Original filename. |
content_type | string | MIME content type. |
width | int32 | Image or video width in pixels, when known. |
height | int32 | Image or video height in pixels, when known. |
asset_url | MessageAssetUrl | Signed URL for the original asset, when available. |
thumbnail_asset_url | MessageAssetUrl | Signed URL for a thumbnail image, when available. GIFs routed to video processing use the generated video thumbnail. The URL is absent when that thumbnail is unavailable. |
video_processing | MessageVideoProcessing | Video processing metadata for videos and animated GIFs. |
description | optional string | User-provided description for accessibility and attachment details. Absent when the attachment has no description. |
MessageReaction
Section titled “MessageReaction”Aggregated reaction state for one emoji on one message.
This state is scoped to the current message and includes whether the current user has reacted with the same emoji.
| Field | Type | Description |
|---|---|---|
emoji | string | Emoji or reaction key. |
count | int32 | Number of users who reacted with this emoji. |
has_reacted | bool | True when the current user reacted with this emoji. |
preview_user_ids | repeated string | Preview of up to five user IDs that reacted with this emoji. |
MessageVideoHLS
Section titled “MessageVideoHLS”HLS adaptive-streaming metadata for a processed video.
| Field | Type | Description |
|---|---|---|
master_playlist_url | MessageAssetUrl | Signed URL for the HLS master playlist. The URL authorises all playlists and segments in this video generation and expires with the attachment URL. |
MessageVideoProcessing
Section titled “MessageVideoProcessing”Processing metadata for a video attachment.
Clients can use this object to show upload/transcoding progress and decide whether to play a processed variant, show a thumbnail, or display a failure state.
| Field | Type | Description |
|---|---|---|
status | MessageVideoProcessingStatus | Current processing status. |
duration_ms | int64 | Video duration in milliseconds. |
width | int32 | Source video width in pixels. |
height | int32 | Source video height in pixels. |
source_available | bool | True when the original source asset is currently available. |
reason_code | string | Stable reason code for a failed or incomplete processing state. |
thumbnail_asset_url | MessageAssetUrl | Signed URL for the generated thumbnail, when available. |
variants | repeated MessageVideoVariant | Available transcoded renditions. |
hls | MessageVideoHLS | Adaptive-streaming metadata. Absent on MP4-only historical results and servers that do not support HLS processing. |
MessageVideoVariant
Section titled “MessageVideoVariant”One transcoded video rendition.
| Field | Type | Description |
|---|---|---|
quality | string | Quality label for the rendition. |
width | int32 | Video width in pixels. |
height | int32 | Video height in pixels. |
size | int64 | Rendition size in bytes. |
asset_url | MessageAssetUrl | Signed URL for the rendition. |
MessageViewerState
Section titled “MessageViewerState”Viewer-specific capabilities for one message, independent of whether its canonical thread has been established.
| Field | Type | Description |
|---|---|---|
can_reply_in_thread | optional bool | Whether the viewer can reply in this message’s canonical thread, including starting the first reply to a root. Includes read access, room policy, and broad or interaction-scoped posting authority. Absent when not resolved. |
thread_slow_mode_next_post_at | google.protobuf.Timestamp | Earliest reply time in this message’s canonical thread, including when the root has no replies. Absent when disabled, expired, or bypassed. |
ThreadSummary
Section titled “ThreadSummary”Aggregated state for one message thread.
| Field | Type | Description |
|---|---|---|
thread_root_event_id | string | Event ID of the root message for the thread. |
reply_count | int32 | Number of replies in this message’s thread. |
last_reply_at | google.protobuf.Timestamp | Creation time of the most recent reply in this message’s thread. |
participant_preview_user_ids | repeated string | Preview of up to twelve distinct thread authors, excluding erased users. The root author appears first, followed by current reply authors. |
participant_count | int32 | Total number of distinct root and current reply authors, excluding erased users. |
viewer_state | ThreadViewerState | State resolved for the current user. |
ThreadViewerState
Section titled “ThreadViewerState”Viewer-specific follow and reply-read state for one message thread.
| Field | Type | Description |
|---|---|---|
is_following | optional bool | Whether the current user follows this message’s thread, when known. |
has_unread_replies | optional bool | True when the thread contains replies after the current user’s read cursor, when known. |
slow_mode_next_post_at | google.protobuf.Timestamp | Earliest time the viewer may reply. Absent when disabled, expired, or bypassed. The root message starts its author’s thread cooldown. |
Room-scoped binary asset metadata and freshly signed URLs.
| Field | Type | Description |
|---|---|---|
id | string | Stable asset ID. |
filename | string | Original filename. |
content_type | string | MIME content type. |
size | int64 | Stored file size in bytes. |
width | int32 | Media width when known. |
height | int32 | Media height when known. |
asset_url | MessageAssetUrl | Signed URL for the original asset bytes. |
thumbnail_asset_url | MessageAssetUrl | Signed thumbnail image URL, when available. GIFs routed to video processing use the generated video thumbnail without image transform options. Absent when that thumbnail is unavailable. |
video_processing | MessageVideoProcessing | Video processing state for videos and animated GIFs. |
RoomAttachmentListItem
Section titled “RoomAttachmentListItem”One current room attachment and its message anchor.
| Field | Type | Description |
|---|---|---|
attachment | Asset | Attachment metadata and signed URLs. |
message_event_id | string | Message event containing the attachment. |
thread_root_event_id | string | Thread root event ID when the containing message is a thread reply. |
created_at | google.protobuf.Timestamp | Message creation timestamp. |
description | optional string | User-provided description for this attachment. Absent when the attachment has no description. |
DirectoryMember
Section titled “DirectoryMember”Public user/member row used by user directory, room membership, and mention surfaces.
| Field | Type | Description |
|---|---|---|
user | User | Public user fields. |
roles | repeated string | Explicit roles assigned to the user. Member listings include the virtual everyone role for parity with Chatto’s permission model. |
created_at | google.protobuf.Timestamp | Account creation time when known. |
ReadMarker
Section titled “ReadMarker”Current stored read position. Its event can later be retracted. The timestamp is absent if the event can no longer be resolved. This is not Badge attention.
| Field | Type | Description |
|---|---|---|
last_read_event_id | string | Last-read event ID, to locate the boundary in a timeline. |
last_read_at | google.protobuf.Timestamp | Creation time of the last-read event, when available. |
RoomReadState
Section titled “RoomReadState”Current viewer’s stored room read state.
| Field | Type | Description |
|---|---|---|
room_id | string | Room ID. |
marker | ReadMarker | Absent when no non-empty marker has been stored. Reading never initializes it. |
ThreadReadState
Section titled “ThreadReadState”Current viewer’s stored thread read state.
| Field | Type | Description |
|---|---|---|
room_id | string | Room ID. |
thread_root_event_id | string | Root message ID. |
marker | ReadMarker | Absent when no non-empty marker has been stored. Reading never advances it. |
ThreadReadStateTarget
Section titled “ThreadReadStateTarget”Room and root identity for one thread read state.
| Field | Type | Description |
|---|---|---|
room_id | string | Room ID. |
thread_root_event_id | string | Root message ID. |
RoomMessagePosted
Section titled “RoomMessagePosted”Payload for a message-posted timeline event.
| Field | Type | Description |
|---|---|---|
message | Message | Renderable message created by this timeline event. |
RoomTimelineCallEvent
Section titled “RoomTimelineCallEvent”Payload for voice-call lifecycle timeline events.
| Field | Type | Description |
|---|---|---|
room_id | string | Room containing the call. |
call_id | string | Stable identifier for this call session. |
RoomTimelineEvent
Section titled “RoomTimelineEvent”One event in a room or thread timeline.
Clients should inspect the event oneof to choose the renderer for the event.
| Field | Type | Description |
|---|---|---|
id | string | Stable event ID. |
created_at | google.protobuf.Timestamp | Time when the event was created. |
actor_id | string | User ID of the event actor. |
event.message_posted | RoomMessagePosted | A message was posted. |
event.room_created | RoomTimelineRoomEvent | The room was created. |
event.room_updated | RoomTimelineRoomEvent | The room metadata was updated. |
event.room_deleted | RoomTimelineRoomEvent | The room was deleted. |
event.room_archived | RoomTimelineRoomEvent | The room was archived. |
event.room_unarchived | RoomTimelineRoomEvent | The room was unarchived. |
event.room_threading_mode_changed | RoomTimelineThreadingModeChangedEvent | The room’s Threading Mode changed. |
event.user_joined_room | RoomTimelineRoomEvent | A user joined the room. |
event.user_left_room | RoomTimelineRoomEvent | A user left the room. |
event.call_started | RoomTimelineCallEvent | A voice call started in the room. |
event.call_ended | RoomTimelineCallEvent | The voice call ended in the room. |
RoomTimelineIncludes
Section titled “RoomTimelineIncludes”Related entities included beside timeline/feed events.
Includes are reserved for hot paginated feed paths where many events may repeatedly reference the same render data. Other APIs should return resources directly and rely on BatchGet-style follow-up hydration instead of adding includes maps.
| Field | Type | Description |
|---|---|---|
users | map<string, User> | Users keyed by user ID. |
RoomTimelinePage
Section titled “RoomTimelinePage”Cursor page of room or thread timeline events.
Use opaque start_cursor and end_cursor values with before/after requests to continue paging in either direction. Clients must treat cursor values as server-owned tokens and must not parse, construct, share between users, or reuse them for another room or thread. The server binds each cursor to the authenticated viewer and exact timeline resource. The has_older and has_newer flags tell clients whether another request can extend the current window.
| Field | Type | Description |
|---|---|---|
events | repeated RoomTimelineEvent | Events in chronological display order, oldest first. |
start_cursor | string | Opaque cursor for the first event in the page. |
end_cursor | string | Opaque cursor for the last event in the page. |
has_older | bool | True when older events are available before start_cursor. |
has_newer | bool | True when newer events are available after end_cursor. |
includes | RoomTimelineIncludes | Hot-path related entities needed to render the page without per-event hydration. |
RoomTimelineRoomEvent
Section titled “RoomTimelineRoomEvent”Payload for room lifecycle and membership timeline events.
| Field | Type | Description |
|---|---|---|
room_id | string | Room affected by the event. |
RoomTimelineThreadingModeChangedEvent
Section titled “RoomTimelineThreadingModeChangedEvent”Payload for a room Threading Mode change shown in the room timeline.
| Field | Type | Description |
|---|---|---|
room_id | string | Room whose Threading Mode changed. |
threading_mode | RoomThreadingMode | Newly configured Threading Mode. |
PinnedMessage
Section titled “PinnedMessage”One current pinned message in a channel room.
| Field | Type | Description |
|---|---|---|
message | Message | Current renderable message. Retracted messages are omitted from pin lists. |
Public room metadata returned by room commands.
| Field | Type | Description |
|---|---|---|
id | string | Stable room ID. |
kind | RoomKind | Room kind. |
name | string | Room name. Direct-message rooms may have an empty name because clients derive their display label from participants. |
description | string | Optional room description. |
archived | bool | True when the room is archived and hidden from active room lists. |
group_id | string | Room group ID for channel rooms. Empty for direct-message rooms. |
universal | bool | True when a channel grants effective membership to eligible server members. |
slow_mode_seconds | uint32 | Minimum number of seconds a non-exempt member must wait between root message posts. Channel rooms only; zero means slow mode is disabled. |
threading_mode | RoomThreadingMode | Effective threading policy for this room. Direct-message rooms always report ENABLED. |
thread_slow_mode_seconds | optional uint32 | Per-user interval within each thread, including its root. Zero disables the interval. Absent on servers without independent thread slow mode. |
created_at | google.protobuf.Timestamp | When the room was created. Absent when unavailable on an older server. |
show_membership_events | optional bool | Whether clients show room join/leave activity. Absence on older servers means true. Membership state and event delivery are not affected. |
RoomNotice
Section titled “RoomNotice”Current member-only notice in a channel room.
| Field | Type | Description |
|---|---|---|
body | string | Markdown source. Empty means the notice has been cleared. |
version | string | Opaque write version. Send it with every mutation. Empty before first publish. |
publication_id | string | Opaque dismissal revision. Corrections preserve it; publish and republish replace it. Empty when there is no published notice. |
published_at | google.protobuf.Timestamp | Time of publication or explicit republishing. Corrections preserve it. Absent when cleared or unavailable on an older server. |
RoomSummary
Section titled “RoomSummary”Lightweight room reference for cross-resource rows.
| Field | Type | Description |
|---|---|---|
id | string | Stable room ID. |
kind | RoomKind | Room kind. |
name | string | Room name. Direct-message rooms may have an empty name because clients derive their display label from participants. |
RoomSuspension
Section titled “RoomSuspension”Active channel room suspension with optional hydrated references.
| Field | Type | Description |
|---|---|---|
id | string | Stable suspension event ID. |
room_id | string | Channel room ID. |
room | Room | Channel room metadata, when the referenced room still exists. |
user_id | string | Suspended user ID. |
user | DirectoryMember | Suspended user profile, when the referenced user still exists. |
moderator_id | string | Moderator user ID that created the suspension. |
moderator | DirectoryMember | Moderator profile, when the referenced user still exists. |
reason | string | Moderator-entered removal reason. |
created_at | google.protobuf.Timestamp | Time the suspension was created. |
expires_at | google.protobuf.Timestamp | Optional future time when the suspension expires. Absence means indefinite. |
RoomGroup
Section titled “RoomGroup”Ordered group of channel rooms and sidebar links.
| Field | Type | Description |
|---|---|---|
id | string | Stable room group ID. |
name | string | Display name. |
description | string | Public group description, when set. |
items | repeated RoomGroupItem | Mixed room/sidebar-link entries in sidebar order. |
viewer_state | RoomGroupViewerState | State and permissions resolved for the current user. |
RoomGroupItem
Section titled “RoomGroupItem”One ordered item in a room group.
| Field | Type | Description |
|---|---|---|
item.room | RoomWithViewerState | Visible room entry. |
item.sidebar_link | SidebarLink | Sidebar link entry. |
RoomGroupViewerState
Section titled “RoomGroupViewerState”Viewer-specific state for one room group.
| Field | Type | Description |
|---|---|---|
permissions | repeated PermissionGrant | Effective group-scoped permission decisions after group state constraints. |
RoomViewerState
Section titled “RoomViewerState”Viewer-specific state and permission decisions for one room.
| Field | Type | Description |
|---|---|---|
is_member | bool | True when the current user is an effective room member. |
has_unread | bool | True when the room has neutral Badge attention for the current user. This state is independent of the user’s last-read message cursor. |
permissions | repeated PermissionGrant | Effective room-scoped permission decisions after room state constraints. |
slow_mode_next_post_at | google.protobuf.Timestamp | Earliest time the current user may create another root message. Absent when slow mode is disabled, expired, or bypassed by moderation permissions. |
invitation | RoomInvitation | Pending invitation for this viewer; does not grant access to room content. |
can_rejoin | optional bool | Whether current permissions and room state allow joining without an invitation, even if already a member. Absent on servers that do not report this decision. |
RoomWithViewerState
Section titled “RoomWithViewerState”Room metadata plus state and capabilities resolved for the authenticated viewer.
| Field | Type | Description |
|---|---|---|
room | Room | Public room metadata. |
viewer_state | RoomViewerState | State and permission decisions resolved for the current user. |
member_user_ids | repeated string | Complete participant user IDs for a DM, including participants whose accounts were deleted. Clients show those as deleted users. Empty for channel rooms. |
has_message_history | optional bool | Whether this DM has an ordinary root message that the viewer can read. Absent for channel rooms. |
last_message_at | google.protobuf.Timestamp | Creation time of the latest ordinary DM message that the viewer can read, including thread replies. Interaction-only access includes related threads. Edits and retractions do not change this value; historical imports are excluded. Absent for other room kinds or when no ordinary message is readable. Older servers can omit this field. Absence does not prove inactivity. |
last_root_message_at | google.protobuf.Timestamp | Creation time of the latest ordinary DM root message, excluding thread replies. Uses the same visibility, import, and absence rules as last_message_at. |
SidebarLink
Section titled “SidebarLink”Sidebar link metadata for room group navigation.
| Field | Type | Description |
|---|---|---|
id | string | Stable sidebar link ID. |
label | string | Display label. |
url | string | Absolute http(s) URL or server-local path. |
ServerLogin
Section titled “ServerLogin”Login and registration options exposed before authentication.
| Field | Type | Description |
|---|---|---|
direct_registration_enabled | bool | Whether users can create accounts through the public UI. |
providers | repeated ProviderMetadata | Configured login providers. |
authorize_url | string | URL for the legacy authorization flow, when enabled. |
account_creation_policy | AccountCreationPolicy | Admission policy for direct registration and provider auto-provisioning. |
direct_login_enabled | optional bool | Whether users can sign in directly with a username or email address and password. Absent on older servers, where clients should treat direct login as enabled. |
ServerPublicProfile
Section titled “ServerPublicProfile”Public server profile, identity, and branding fields.
| Field | Type | Description |
|---|---|---|
name | string | Display name of the Chatto server. |
version | string | Server software version. |
logo_url | optional string | Optional server logo URL. |
banner_url | optional string | Optional server banner URL. |
welcome_message | optional string | Optional welcome message. |
description | optional string | Optional server description. |
ExternalIdentityProvider
Section titled “ExternalIdentityProvider”Public metadata for a configured external login provider.
| Field | Type | Description |
|---|---|---|
link_url | string | URL that starts authenticated account linking for this provider. Clients should use StartExternalIdentityLink instead of navigating here directly. |
linked | bool | True when this provider is already linked to the authenticated user. |
linked_identity_subject_hash | string | Linked identity subject hash for this provider, when linked. |
provider | ProviderMetadata | Shared provider metadata. |
LinkedExternalIdentity
Section titled “LinkedExternalIdentity”Linked provider identity metadata for the authenticated user’s settings UI.
| Field | Type | Description |
|---|---|---|
provider_id | string | Provider ID recorded when the identity was linked. |
provider_type | string | Provider type recorded when the identity was linked. |
provider_label | string | Current or fallback provider label. |
subject_hash | string | Stable one-way subject hash, useful only as a UI/list key. |
disconnect_eligibility | DisconnectEligibility | Disconnect eligibility evaluated by ListExternalIdentities. |
AccountActions
Section titled “AccountActions”Self-service decisions for the current viewer. Each action owns its states.
| Field | Type | Description |
|---|---|---|
change_username | UsernameChangeAvailability | Changing the username, excluding input-specific exceptions such as case-only edits. |
change_password | optional PasswordChangeAvailability | Setting an initial password or changing an existing password. Absent on older servers. |
delete_account | optional AccountDeletionAvailability | Starting self-service account deletion. Absent on older servers. |
UsernameChangeAvailability
Section titled “UsernameChangeAvailability”Snapshot for changing a username. Missing means not reported. Commands still check policy and input, including case-only exceptions. ALLOWED enables it only when available_at is absent or has passed.
| Field | Type | Description |
|---|---|---|
state | UsernameChangeAvailability.State | Unknown states remain disabled. Commands recheck authority and policy. |
available_at | google.protobuf.Timestamp | Independent earliest attempt time. Absent means no time restriction. Clients enable ALLOWED when this time passes; they should update a visible control once per second while waiting and stop its timer when it is removed or no longer waiting. This time never overrides a blocking or unknown state. |
PrivilegedModeState
Section titled “PrivilegedModeState”State of explicit privileged-mode activation for this authenticated session.
| Field | Type | Description |
|---|---|---|
available | bool | Whether the user has an elevation-required permission entitlement. This includes owner entitlement and explicit allows at any supported scope. |
active | bool | Whether elevated permissions are effective for this session now. |
expires_at | google.protobuf.Timestamp | Absolute activation deadline. Present only while privileged mode is active. |
ServerViewerPermissions
Section titled “ServerViewerPermissions”Effective server/channel permission decisions for the authenticated user.
| Field | Type | Description |
|---|---|---|
permissions | repeated PermissionGrant | One row per permission known to the server. |
ServerViewerState
Section titled “ServerViewerState”Non-permission server state for the authenticated user.
| Field | Type | Description |
|---|---|---|
has_unread_rooms | bool | Whether any joined channel room has neutral Badge attention. |
UserSettings
Section titled “UserSettings”Server-level display settings for the authenticated user.
| Field | Type | Description |
|---|---|---|
timezone | optional string | Optional IANA timezone override. Absent means no choice has been recorded. Empty means the user explicitly chose the browser’s local timezone. Both use browser-local time; only absence permits automatic device reporting. |
time_format | TimeFormat | Preferred time format. |
share_timezone | optional bool | Whether the stored time zone may appear on the user’s public profile. New servers always set this field. Its absence means the server does not support private time zones and may publish any stored time zone. |
ViewerCapabilities
Section titled “ViewerCapabilities”Permission-derived capabilities for the authenticated user.
| Field | Type | Description |
|---|---|---|
grants | repeated CapabilityGrant | Keyed capability decisions for the authenticated user. |
has_unread_followed_threads | bool | Whether the user has unread followed threads. |
ViewerUser
Section titled “ViewerUser”Current authenticated user’s public profile plus self-only settings.
| Field | Type | Description |
|---|---|---|
has_verified_email | bool | Whether the account has at least one verified email address. |
settings | UserSettings | Current user’s display settings. |
viewer_can_delete_account | bool | Deprecated. Whether the authenticated user may delete this account. New clients use actions.delete_account and fall back to this field only when that action is absent. |
last_login_change | google.protobuf.Timestamp | Last time a login credential changed, when known. |
profile | User | Public user fields for the authenticated user. |
has_password | bool | Whether this account currently has a password sign-in credential. |
actions | AccountActions | Self-service account action snapshots. Absent on older servers. |
VerifiedEmail
Section titled “VerifiedEmail”One email address that the authenticated user has proved they control.
| Field | Type | Description |
|---|---|---|
email | string | Normalized email address. |
verified_at | google.protobuf.Timestamp | Time at which the address was verified. |
primary | bool | Whether account-directed email is sent to this address. |
AssetUpload
Section titled “AssetUpload”Current server-side state for one room-scoped attachment upload.
| Field | Type | Description |
|---|---|---|
upload_id | string | Upload session ID. |
room_id | string | Room the resulting attachment asset will belong to. |
status | AssetUploadStatus | Current upload status. |
committed_offset | int64 | Number of bytes committed so far. |
size | int64 | Total declared file size in bytes. |
max_chunk_size | int32 | Maximum accepted chunk size in bytes. |
sha256 | string | SHA-256 digest of the complete file, lowercase hexadecimal. |
expires_at | google.protobuf.Timestamp | Upload expiry. Clients should create a new upload after this time. |
asset_id | string | Asset ID after completion. |
A managed bot account. Raw API keys are returned only when Chatto issues them.
| Field | Type | Description |
|---|---|---|
user | User | Canonical public bot identity. |
owner_user_id | string | Stable human owner user ID. |
created_at | google.protobuf.Timestamp | Account creation time. |
api_key_created_at | google.protobuf.Timestamp | Legacy time for the initial API key. Use api_keys for active credentials. |
incoming_webhooks | repeated BotIncomingWebhook | Active incoming webhook credentials, ordered by creation time. |
api_keys | repeated BotApiKey | Active API keys, ordered by creation time. |
last_login_change | google.protobuf.Timestamp | Time of the last username change that started the 30-day username cooldown. Absent when no cooldown was started. The bot, its owner, and bot managers cannot change the username again until the cooldown ends. A caller with user.manage-accounts can change it at any time. |
BotApiKey
Section titled “BotApiKey”Safe metadata for one active bot API key. The raw key is returned only when Chatto creates it.
| Field | Type | Description |
|---|---|---|
id | string | Stable API-key credential ID. |
name | string | Manager-defined name. |
created_at | google.protobuf.Timestamp | Time the API key was created. |
last_used_state | CredentialLastUsedState | Availability of best-effort last-use telemetry. |
last_used_at | optional google.protobuf.Timestamp | Most recent recorded successful authentication time. |
BotIncomingWebhook
Section titled “BotIncomingWebhook”Safe metadata for one active bot incoming webhook. The webhook URL is returned only when the credential is created.
| Field | Type | Description |
|---|---|---|
id | string | Stable webhook credential ID. |
name | string | Manager-defined name for the credential. |
created_at | google.protobuf.Timestamp | Time the incoming webhook credential was created. |
last_used_state | CredentialLastUsedState | Availability of best-effort last-use telemetry. |
last_used_at | optional google.protobuf.Timestamp | Most recent recorded successful authentication time. |
BotOutboundWebhook
Section titled “BotOutboundWebhook”Endpoint settings visible only to the bot owner or a caller with bot.manage. Authorization and signing credentials are write-only. The saved URL is visible.
| Field | Type | Description |
|---|---|---|
id | string | Stable ID of this endpoint. |
enabled | bool | Whether this configuration accepts new messages. |
has_authorization | bool | Whether an Authorization header is configured. |
latest_failure | BotWebhookFailure | Latest retained failure for this endpoint. Absent when no failure is retained. Later successes do not clear it. Absence does not prove successful delivery. |
url | string | Saved destination. May contain tool credentials; visible only to bot managers. |
name | string | Human-readable name assigned at creation. |
created_at | google.protobuf.Timestamp | Time this endpoint was created. |
BotWebhookFailure
Section titled “BotWebhookFailure”Safe summary of one recorded outbound webhook failure.
| Field | Type | Description |
|---|---|---|
id | string | Stable delivery identifier shared by all retry attempts. |
reason | string | Safe failure category. Never contains response bodies or credentials. |
attempts | uint32 | Delivery attempts, up to the attempt limit. An attempt can fail before HTTP starts, so this is not an exact HTTP request count. |
http_status | uint32 | Zero if no HTTP response was received. |
completed_at | google.protobuf.Timestamp | Time the retained failure was recorded. |
source_event_id | string | Source message ID associated with this delivery. |
FollowedThread
Section titled “FollowedThread”One followed thread for the current user.
| Field | Type | Description |
|---|---|---|
root_message | Message | Renderable root message, when the root is still visible. |
room | RoomSummary | Room containing the thread. |
thread | ThreadSummary | Aggregated thread state. |
latest_reply | Message | Most recent visible reply, when the thread has one. |
direct_message_participant_user_ids | repeated string | User IDs used to derive a direct-message conversation label. Empty for channel rooms. |
ThreadFollowState
Section titled “ThreadFollowState”Current follow state for one thread and viewer.
| Field | Type | Description |
|---|---|---|
room_id | string | Room containing the thread. |
thread_root_event_id | string | Event ID of the root message for the thread. |
following | bool | True when the current user follows the thread. |
MessageSearchResult
Section titled “MessageSearchResult”One current, authorized match. With thread grouping, each result represents one thread and message is its best match in the selected order.
| Field | Type | Description |
|---|---|---|
message | Message | Current renderable message that matched the query. |
relevance_score | double | Search-provider relevance score. Higher values are more relevant for the same query. Clients may merge results from servers using compatible search implementations by this value. |
thread_context | ThreadSearchContext | Present only with THREAD grouping. The matching message can be a reply; the root and latest reply in this context need not match the query. |
ThreadSearchContext
Section titled “ThreadSearchContext”Current context for a grouped match. The viewer need not follow this thread. Search evidence stays on the containing MessageSearchResult.
| Field | Type | Description |
|---|---|---|
root_message | Message | Renderable root message, when still visible. |
room | RoomSummary | Room containing this thread. |
thread | ThreadSummary | Current thread metadata and viewer follow/read state. |
latest_reply | Message | Most recent visible reply, when present; it need not match the query. |
direct_message_participant_user_ids | repeated string | Conversation-label participants for direct messages; empty for channels. |
MessageAttachmentDescriptionInput
Section titled “MessageAttachmentDescriptionInput”Description supplied for one attachment in a new message.
| Field | Type | Description |
|---|---|---|
asset_id | string | Required. Asset ID included in attachment_asset_ids on the same request. |
description | string | Plain-text description with at most 1,000 Unicode characters. Trim outer whitespace before sending. Chatto also trims outer whitespace, preserves internal line breaks, and omits an empty result. |
AllMentionReceived
Section titled “AllMentionReceived”An @all message that included the viewer.
| Field | Type | Description |
|---|---|---|
message | NotificationMessageReference | No field description provided. |
DirectMentionReceived
Section titled “DirectMentionReceived”A message that mentions the viewer directly.
| Field | Type | Description |
|---|---|---|
message | NotificationMessageReference | No field description provided. |
DirectMessageReceived
Section titled “DirectMessageReceived”A direct message sent to the viewer.
| Field | Type | Description |
|---|---|---|
message | NotificationMessageReference | No field description provided. |
FollowedRoomActivity
Section titled “FollowedRoomActivity”Deprecated compatibility payload. Chatto does not derive this signal.
| Field | Type | Description |
|---|---|---|
message | NotificationMessageReference | No field description provided. |
FollowedThreadActivity
Section titled “FollowedThreadActivity”Activity in a thread followed by the viewer.
| Field | Type | Description |
|---|---|---|
message | NotificationMessageReference | No field description provided. |
HereMentionReceived
Section titled “HereMentionReceived”An @here message that included the viewer.
| Field | Type | Description |
|---|---|---|
message | NotificationMessageReference | No field description provided. |
NotificationDeliveryModes
Section titled “NotificationDeliveryModes”Delivery modes for Chatto’s finite built-in notification signal classes. Presence is significant: absent fields inherit in a stored policy.
| Field | Type | Description |
|---|---|---|
direct_messages | optional NotificationDeliveryMode | No field description provided. |
direct_mentions | optional NotificationDeliveryMode | No field description provided. |
replies | optional NotificationDeliveryMode | No field description provided. |
role_mentions | optional NotificationDeliveryMode | No field description provided. |
here_mentions | optional NotificationDeliveryMode | No field description provided. |
all_mentions | optional NotificationDeliveryMode | No field description provided. |
followed_threads | optional NotificationDeliveryMode | No field description provided. |
followed_rooms | optional NotificationDeliveryMode | Deprecated. Deprecated compatibility slot. Use room_messages at room scope. |
reactions | optional NotificationDeliveryMode | No field description provided. |
room_messages | optional NotificationDeliveryMode | Delivery mode for root messages posted directly to joined channel rooms. Thread messages and direct messages use their own signal classes. |
room_invitations | optional NotificationDeliveryMode | Delivery mode for invitations to join a channel room. |
NotificationMessageReference
Section titled “NotificationMessageReference”Exact visible message destination carried by a notification signal.
| Field | Type | Description |
|---|---|---|
room | RoomSummary | Room containing the source activity. |
event_id | string | Exact source or reacted-to message event to reveal. |
thread_root_event_id | optional string | Thread root when the target is inside a thread. |
NotificationOccurrence
Section titled “NotificationOccurrence”One exact Notifications 2.0 source occurrence.
| Field | Type | Description |
|---|---|---|
id | string | Stable occurrence ID. |
created_at | google.protobuf.Timestamp | Time of the source activity. |
actor | User | User who caused the source activity, when still visible. |
signal | NotificationSignal | Immutable cause and destination represented by this occurrence. |
unread | bool | Whether this occurrence still contributes unread attention. |
expires_at | google.protobuf.Timestamp | Absolute expiry: the invitation deadline for room invitations, otherwise 90 days after source activity. Handled invitations are removed earlier. |
attention_level | NotificationAttentionLevel | Source-time visual importance of this occurrence. |
NotificationPolicy
Section titled “NotificationPolicy”Explicit and effective delivery modes for one notification policy scope.
| Field | Type | Description |
|---|---|---|
overrides | NotificationDeliveryModes | Explicit modes at the requested scope. Missing fields mean Inherit. |
effective | NotificationDeliveryModes | Complete modes after applying product, server, and room inheritance. |
NotificationPolicyScope
Section titled “NotificationPolicyScope”Explicit target for one notification policy. Clients must select exactly one scope. Direct-message rooms use room scope and never inherit from a room group.
| Field | Type | Description |
|---|---|---|
scope.server | google.protobuf.Empty | Selects the authenticated viewer’s server-wide policy. |
scope.room_group_id | string | Selects one existing room group’s policy. |
scope.room_id | string | Selects one room’s policy. Requires membership or a pending invitation. |
NotificationRoomUnreadCount
Section titled “NotificationRoomUnreadCount”Unread notification occurrences currently targeting one room.
| Field | Type | Description |
|---|---|---|
room_id | string | Target room ID. |
unread_count | int32 | Number of unread occurrences targeting this room. |
important_unread_count | int32 | Unread occurrences in this room with Important attention. |
NotificationSignal
Section titled “NotificationSignal”Immutable, typed cause and destination of one notification. Clients must preserve unknown variants as generic dismissible rows and must not infer navigation semantics for them.
| Field | Type | Description |
|---|---|---|
kind.direct_message_received | DirectMessageReceived | No field description provided. |
kind.direct_mention_received | DirectMentionReceived | No field description provided. |
kind.reply_received | ReplyReceived | No field description provided. |
kind.role_mention_received | RoleMentionReceived | No field description provided. |
kind.here_mention_received | HereMentionReceived | No field description provided. |
kind.all_mention_received | AllMentionReceived | No field description provided. |
kind.followed_thread_activity | FollowedThreadActivity | No field description provided. |
kind.followed_room_activity | FollowedRoomActivity | Deprecated. No field description provided. |
kind.reaction_received | ReactionReceived | No field description provided. |
kind.room_message_received | RoomMessageReceived | No field description provided. |
kind.room_invitation_received | RoomInvitationReceived | No field description provided. |
ReactionReceived
Section titled “ReactionReceived”A reaction added to one of the viewer’s messages.
| Field | Type | Description |
|---|---|---|
message | NotificationMessageReference | No field description provided. |
emoji | string | Exact reaction supplied by the actor. |
ReplyReceived
Section titled “ReplyReceived”A reply to one of the viewer’s messages.
| Field | Type | Description |
|---|---|---|
message | NotificationMessageReference | No field description provided. |
RoleMentionReceived
Section titled “RoleMentionReceived”A message mentioning a role held by the viewer.
| Field | Type | Description |
|---|---|---|
message | NotificationMessageReference | No field description provided. |
role_names | repeated string | Source-time role handles that selected the viewer. Multiple matching role mentions are consolidated into one occurrence for the source message. |
RoomInvitationReceived
Section titled “RoomInvitationReceived”An invitation to join a room. Its destination is the room, not a message. Attention ends when the invitation is handled or reaches the containing NotificationOccurrence’s expires_at deadline.
| Field | Type | Description |
|---|---|---|
room | RoomSummary | No field description provided. |
invitation_id | string | Stable invitation identifier. |
RoomMessageReceived
Section titled “RoomMessageReceived”A root message posted directly to a channel room that the viewer belongs to.
| Field | Type | Description |
|---|---|---|
message | NotificationMessageReference | No field description provided. |
ScopedNotificationPolicy
Section titled “ScopedNotificationPolicy”One policy together with the explicit scope that produced it.
| Field | Type | Description |
|---|---|---|
scope | NotificationPolicyScope | Exact policy scope. |
policy | NotificationPolicy | Explicit and effective modes for the scope. |
ServerRuntimeConfig
Section titled “ServerRuntimeConfig”Authenticated server runtime settings used by clients.
| Field | Type | Description |
|---|---|---|
push_notifications_enabled | bool | Whether Web Push notifications are fully configured. |
vapid_public_key | optional string | Optional VAPID public key for Web Push registration. |
livekit_url | optional string | Optional LiveKit URL for voice and video calls. |
video_processing_enabled | bool | Whether video processing is enabled. |
max_upload_size | int64 | Maximum upload size in bytes for all files, including GIFs and videos. |
max_video_upload_size | int64 | Deprecated. Deprecated alias of max_upload_size. Both fields have the same value. |
message_edit_window_seconds | int32 | Message edit window in seconds. |
ActiveCall
Section titled “ActiveCall”Current active call snapshot for one room.
| Field | Type | Description |
|---|---|---|
room | RoomSummary | Room containing the active call. |
call_id | string | Active call session ID. |
participants | repeated CallParticipant | Participants currently projected for this call. |
CallParticipant
Section titled “CallParticipant”User currently participating in a room call.
| Field | Type | Description |
|---|---|---|
user | User | Participant user. |
joined_at | google.protobuf.Timestamp | When the user joined this call. |
call_id | string | Active call session ID. |
AdminAccountInfo
Section titled “AdminAccountInfo”JetStream account limits and usage.
| Field | Type | Description |
|---|---|---|
memory | int64 | Maximum memory storage in bytes. Values less than or equal to zero mean unlimited. |
memory_used | int64 | Used memory storage in bytes. |
storage | int64 | Maximum file storage in bytes. Values less than or equal to zero mean unlimited. |
storage_used | int64 | Used file storage in bytes. |
streams | int32 | Maximum number of streams. Values less than or equal to zero mean unlimited. |
streams_used | int32 | Current number of streams. |
consumers | int32 | Maximum number of consumers. Values less than or equal to zero mean unlimited. |
consumers_used | int32 | Current number of consumers. |
AdminAssetCleanupStatus
Section titled “AdminAssetCleanupStatus”Current health of recoverable message-owned asset deletion.
| Field | Type | Description |
|---|---|---|
health | AdminAssetCleanupHealth | Operator-facing state derived from the shared durable consumer. |
pending_count | int64 | Deletion effects currently waiting for a successful retry. |
oldest_pending_at | google.protobuf.Timestamp | Deprecated. Deprecated. Shared durable consumers do not expose this value. |
pass_in_progress | bool | Deprecated. Deprecated. Shared durable consumers run continuously rather than in passes. |
last_pass_at | google.protobuf.Timestamp | Deprecated. Deprecated. Shared durable consumers run continuously rather than in passes. |
last_successful_pass_at | google.protobuf.Timestamp | Deprecated. Deprecated. Shared durable consumers run continuously rather than in passes. |
updated_at | google.protobuf.Timestamp | Deprecated. Deprecated. Shared durable consumers do not publish a liveness heartbeat. |
last_pass_failed | bool | Deprecated. Deprecated. Use health and pending_count instead. |
last_inspected_sequence | string | Global EVT sequence of the most recently delivered deletion fact. |
latest_deletion_sequence | string | Current latest global EVT sequence matching asset deletion facts. |
AdminConnectionInfo
Section titled “AdminConnectionInfo”Current NATS server connection metadata.
| Field | Type | Description |
|---|---|---|
connected | bool | Whether Chatto is currently connected to NATS. |
server_id | string | Connected NATS server ID. |
server_name | string | Connected NATS server name. |
version | string | Connected NATS server version. |
max_payload | int64 | Maximum payload accepted by the connected NATS server. |
rtt | string | Round-trip latency to the connected NATS server. |
AdminDurableWorkerStatus
Section titled “AdminDurableWorkerStatus”Broker-derived health for one known durable worker queue.
| Field | Type | Description |
|---|---|---|
key | string | Stable machine-readable worker key. |
health | AdminDurableWorkerHealth | Current availability and work state. |
pending_count | string | Deliveries not yet handed to a handler. |
ack_pending_count | string | Deliveries awaiting acknowledgement; this does not prove handler liveness. |
waiting_count | string | Pull requests currently waiting for work. |
redelivered_count | string | Redelivered messages that remain unacknowledged. |
last_delivered_sequence | string | Latest EVT stream sequence delivered to this queue. |
ack_floor_sequence | string | Highest contiguous EVT stream sequence acknowledged by this queue. |
AdminLiveKitStatus
Section titled “AdminLiveKitStatus”LiveKit voice and video call setup as seen by the Chatto server that handled the request. The response never includes the API secret or the webhook signing secret.
Chatto calls the LiveKit server API once for each request to check reachability and credentials. Webhook times come from the memory of the Chatto server that handled the request. They reset when that server restarts, and other servers in a cluster keep their own times.
| Field | Type | Description |
|---|---|---|
enabled | bool | Whether livekit.enabled is set. |
configured | bool | Whether LiveKit is enabled and the URL, API key, and API secret are all set. |
url | string | Configured LiveKit server URL that clients connect to. |
api_key | string | Configured LiveKit API key. This is an identifier, not a secret. |
separate_webhook_key | bool | Whether webhooks use a signing key that differs from api_key. |
webhook_url | string | URL that LiveKit must send webhooks to. Empty when the public server URL is not set. |
connection_state | AdminLiveKitConnectionState | Result of the LiveKit server API check. |
connection_error | string | Error detail when the check fails. Never contains secrets. |
insecure_url | bool | True when url uses unencrypted ws:// or http:// and the public server URL host is not a loopback address or a .localhost name. |
last_webhook_at | google.protobuf.Timestamp | Time of the last webhook with a valid signature that this server received. |
last_rejected_webhook_at | google.protobuf.Timestamp | Time of the last webhook that this server rejected because of an invalid signature. |
AdminNatsConsumerInfo
Section titled “AdminNatsConsumerInfo”JetStream consumer state.
| Field | Type | Description |
|---|---|---|
stream | string | Stream that owns the consumer. |
name | string | Consumer name. |
durable | string | Durable name, when the consumer is durable. |
filter_subject | string | Single filter subject, when configured. |
filter_subjects | repeated string | Multiple filter subjects, when configured. |
ack_policy | string | NATS acknowledgement policy. |
pull_based | bool | Whether this is a pull consumer. |
push_bound | bool | Whether this push consumer has an active subscription. |
pending | int64 | Pending messages for this consumer. |
ack_pending | int32 | Messages waiting for acknowledgement. |
redelivered | int32 | Redelivered message count. |
waiting | int32 | Pull requests waiting for messages. |
delivered_consumer_sequence | string | Delivered consumer sequence. |
delivered_stream_sequence | string | Delivered stream sequence. |
ack_floor_consumer_sequence | string | Acknowledgement floor consumer sequence. |
ack_floor_stream_sequence | string | Acknowledgement floor stream sequence. |
AdminNatsStats
Section titled “AdminNatsStats”JetStream stream and consumer diagnostics.
| Field | Type | Description |
|---|---|---|
total_messages | int64 | Total messages stored across all streams. |
total_bytes | int64 | Total bytes stored across all streams. |
total_consumer_pending | int64 | Total pending messages across all consumers. |
total_ack_pending | int32 | Total messages currently waiting for acknowledgement. |
streams | repeated AdminNatsStreamInfo | Streams sorted by name. |
consumers | repeated AdminNatsConsumerInfo | Consumers sorted by stream and name. |
AdminNatsStreamInfo
Section titled “AdminNatsStreamInfo”JetStream stream state.
| Field | Type | Description |
|---|---|---|
name | string | Stream name. |
description | string | Stream description. |
subjects | repeated string | Subjects stored in the stream. |
storage | string | Storage backend name. |
messages | int64 | Number of messages in the stream. |
bytes | int64 | Number of bytes in the stream. |
first_sequence | string | First stream sequence. |
last_sequence | string | Last stream sequence. |
consumer_count | int32 | Number of stream consumers. |
replicas | int32 | Configured stream replica count. |
cluster_leader | string | Current cluster leader, when reported by NATS. |
AdminProjectionMetric
Section titled “AdminProjectionMetric”Projection-specific diagnostic metric.
| Field | Type | Description |
|---|---|---|
name | string | Metric name. |
value | int64 | Metric value. |
bytes | int64 | Estimated memory represented by this metric in bytes. |
AdminProjectionState
Section titled “AdminProjectionState”Event-sourced projection health and memory estimates.
| Field | Type | Description |
|---|---|---|
key | string | Stable projection key. |
name | string | Display name. |
subjects | repeated string | EVT subjects consumed by this projection. |
started | bool | Whether the projection projector is running. |
startup_duration_seconds | optional double | Startup duration in seconds, set after startup completes. |
last_applied_sequence | string | Last event sequence applied by the projection. |
matching_stream_sequence | string | Target sequence among the projection’s matching subjects. |
stream_last_sequence | string | Current last sequence of the EVT stream. |
lag | int64 | Matching-subject lag between target and applied sequence. |
failed | bool | Whether the projection failed. |
failed_sequence | string | Sequence that failed, when failed is true. |
failure | string | Failure message, when failed is true. |
entry_count | int64 | Estimated number of entries held by the projection. |
estimated_bytes | int64 | Estimated memory used by the projection in bytes. |
average_entry_bytes | int64 | Estimated average memory per entry in bytes. |
metrics | repeated AdminProjectionMetric | Projection-specific diagnostic metrics. |
AdminServerStats
Section titled “AdminServerStats”Aggregate Chatto object counts.
| Field | Type | Description |
|---|---|---|
user_count | int32 | Registered user count. |
channel_room_count | int32 | Channel room count. |
dm_room_count | int32 | Direct-message room count. |
AdminSystemInfo
Section titled “AdminSystemInfo”Broker and application diagnostics shown on the server admin system page.
| Field | Type | Description |
|---|---|---|
connection | AdminConnectionInfo | Current NATS server connection metadata. |
account | AdminAccountInfo | JetStream account limits and usage. |
nats | AdminNatsStats | JetStream stream and consumer diagnostics. |
stats | AdminServerStats | Aggregate Chatto object counts. |
AdminEventLogEntry
Section titled “AdminEventLogEntry”One durable EVT entry decoded for operator inspection.
| Field | Type | Description |
|---|---|---|
sequence | string | EVT stream sequence. |
subject | string | NATS subject. |
aggregate_type | string | Aggregate type parsed from the subject. |
aggregate_id | string | Aggregate ID parsed from the subject. |
event_type | string | Event oneof payload type, or decode-error when decoding failed. |
event_id | string | Durable event ID. |
actor_id | string | Actor user ID stored on the event. |
created_at | google.protobuf.Timestamp | Event creation timestamp. |
payload_json | string | Pretty-printed, sanitized JSON representation of the event payload. Password verifiers are omitted. |
AdminEventLogFilter
Section titled “AdminEventLogFilter”Filter for owner/auditor event-log inspection.
| Field | Type | Description |
|---|---|---|
event_type | string | Event oneof payload type, such as MessagePostedEvent. |
actor_id | string | Actor user ID. |
created_at_from | google.protobuf.Timestamp | Inclusive lower creation timestamp bound. |
created_at_to | google.protobuf.Timestamp | Inclusive upper creation timestamp bound. |
InvitationCode
Section titled “InvitationCode”Permission to create one account on an invite-only server. Anyone who holds the code can use it; it is not bound to an email address or recipient.
| Field | Type | Description |
|---|---|---|
id | string | No field description provided. |
code | string | Recoverable capability, visible to its creator with user.invite or to invitation managers. Never log it. |
created_by | string | No field description provided. |
created_at | google.protobuf.Timestamp | No field description provided. |
expires_at | google.protobuf.Timestamp | Absent means no expiry. Revocation and successful account creation still invalidate the code. |
status | InvitationCodeStatus | No field description provided. |
revoked_at | google.protobuf.Timestamp | No field description provided. |
note | string | Optional creation-time note for the creator and invitation managers. Empty means no note. This does not restrict who can redeem the code. |
AdminRole
Section titled “AdminRole”Role metadata plus optional administrative totals. Permission decisions are read through AdminPermissionService. Clients that used permissions or permission_denials must migrate to GetRolePermissionMatrix or ListRolePermissionDecisions. These reads require role.manage.
| Field | Type | Description |
|---|---|---|
role | chatto.api.v1.Role | Public role metadata shared with ordinary role catalog reads. |
member_count | optional uint64 | Active human members, including implicit membership for everyone. Reported by ListRoles only, for callers with role.manage or role.assign. |
permission_grant_count | optional uint64 | Explicit permission grants across all scopes; excludes virtual owner access. Reported by ListRoles only, for callers with role.manage or role.assign. |
permission_denial_count | optional uint64 | Explicit permission denials across all scopes. Reported by ListRoles only, for callers with role.manage or role.assign. |
AdminMember
Section titled “AdminMember”User row returned by server-admin member management reads.
The embedded user record carries public identity fields; remaining fields are admin/member metadata with visibility controlled by the service.
| Field | Type | Description |
|---|---|---|
roles | repeated string | Explicit role assignments. The implicit everyone role is omitted. |
created_at | google.protobuf.Timestamp | Account creation time, when known. |
has_verified_email | bool | Whether the caller may see that the user has a verified email and one exists. |
verified_emails | repeated string | Verified email addresses visible to the caller. |
viewer_can_delete_account | bool | Whether the caller may delete this account. |
last_login_change | google.protobuf.Timestamp | Start of the current username-change cooldown, when visible and known. |
user | chatto.api.v1.User | Public identity fields for this user. |
primary_verified_email | optional string | Selected primary verified email visible to the caller. Absence can mean that no primary email exists or that the field is not visible. |
deactivated | bool | Deactivated accounts retain their data but cannot use the server. |
viewer_can_change_deactivation | optional bool | Whether the caller may deactivate or reactivate this account. Absent on servers that do not support account deactivation. |
UserRoleAssignments
Section titled “UserRoleAssignments”Explicit role assignments and current assignment limits for one human user. This resource contains no account details. The implicit everyone role is omitted from all lists. List order is not significant. Limits are advisory: commands check current authority again. Read this resource again after an assignment, revocation, or permission change.
| Field | Type | Description |
|---|---|---|
user_id | string | Target stable user ID. |
role_names | repeated string | Roles explicitly assigned to the target. |
assignable_role_names | repeated string | Roles within the caller’s current grant authority. |
revocable_role_names | repeated string | Roles within the caller’s current revoke authority for this target, including self-protection and configured-owner restrictions. A listed role need not currently be assigned. |
OAuthClient
Section titled “OAuthClient”An OAuth client that completed at least one successful user authorization.
| Field | Type | Description |
|---|---|---|
client_id | string | Stable client identifier: a CIMD URL or built-in application URI. |
client_name | string | Display name from validated client metadata. |
client_origin | string | Privacy-safe canonical origin derived from validated client metadata. |
source | OauthClientSource | How the client identity was established. |
policy | OauthClientPolicy | Current server-administrator policy for the client. |
first_authorization_at | google.protobuf.Timestamp | When this server first completed an authorization for the client. |
last_authorization_at | google.protobuf.Timestamp | When this server most recently completed an authorization for the client. |
redirect_origins | repeated string | Canonical web origins or native callback schemes seen during authorization. |
authorized_user_count | uint32 | Number of distinct users who have authorized this client. |
PermissionDecisionUpdate
Section titled “PermissionDecisionUpdate”Stored permission decision returned after a write.
| Field | Type | Description |
|---|---|---|
permission | string | Permission identifier. |
scope | PermissionScope | Server, direct-message, group, or room scope for this decision. |
decision | PermissionDecision | Stored decision after the write. NONE means no explicit decision remains. |
PermissionExplanation
Section titled “PermissionExplanation”Full decision trace for one permission and target user.
| Field | Type | Description |
|---|---|---|
permission | string | Permission identifier. |
state | PermissionDecision | Overall decision after resolving named subjects and the everyone baseline. |
decided_at | PermissionDecisionLevel | Level of the winning decision, when state is not NONE. |
decided_by_role | string | Role name, user ID, or policy marker that produced the winning decision. |
trace | repeated PermissionTraceEntry | Ordered decision trace. The first entry is the winning decision. |
included_by_permission | string | Permission whose effective allow includes this permission. Empty when the permission was resolved directly. |
PermissionMatrixCell
Section titled “PermissionMatrixCell”Matrix cell for one permission and scope.
| Field | Type | Description |
|---|---|---|
permission | string | Permission identifier. |
scope_id | string | Scope ID matching PermissionMatrixScope.id. |
override | PermissionDecision | Explicit decision at this scope. |
effective | PermissionDecision | Effective decision at this scope. |
allow_permitted | optional bool | Whether an explicit allow may currently be stored for this target. Absent when no additional delegation ceiling applies. |
PermissionMatrixScope
Section titled “PermissionMatrixScope”Matrix column scope.
| Field | Type | Description |
|---|---|---|
id | string | Stable scope ID for the server, direct messages, a group, or a room. |
label | string | Human-readable label. |
kind | PermissionScopeKind | Scope tier. |
parent_group_id | string | Parent group ID for room scopes. |
PermissionScope
Section titled “PermissionScope”Permission scope reference.
| Field | Type | Description |
|---|---|---|
kind | PermissionScopeKind | Scope tier. |
id | string | Scope ID for group or room scope. Empty for server or direct-message scope. |
PermissionTraceEntry
Section titled “PermissionTraceEntry”One explicit decision encountered while explaining a permission.
| Field | Type | Description |
|---|---|---|
level | PermissionDecisionLevel | Level at which this decision was observed. |
role_name | string | Role name, user ID, or policy marker that produced the decision. |
decision | PermissionDecision | Decision observed at this trace step. |
applied | bool | Whether this entry is the winning decision. |
RolePermissionMatrix
Section titled “RolePermissionMatrix”Complete permission matrix for one role at the matching scopes.
| Field | Type | Description |
|---|---|---|
role_name | string | Role name. |
applicable_permissions | repeated string | Permissions rendered as rows. |
scopes | repeated PermissionMatrixScope | Scopes rendered as columns. |
cells | repeated PermissionMatrixCell | Sparse matrix cells. |
ScopedPermissionDecision
Section titled “ScopedPermissionDecision”One resource-oriented permission decision at a concrete scope.
This is the row-oriented counterpart to PermissionMatrixCell. Prefer this shape when building integrations that do not need matrix column joins.
| Field | Type | Description |
|---|---|---|
permission | string | Permission identifier. |
scope | PermissionScope | Server, direct-message, group, or room scope for this decision. |
override | PermissionDecision | Explicit decision stored at this scope. |
effective | PermissionDecision | Effective decision after inherited broader scopes are applied. |
TierPermissions
Section titled “TierPermissions”Permission grants and denials at a single tier.
| Field | Type | Description |
|---|---|---|
permissions | repeated string | Explicitly granted permissions. |
permission_denials | repeated string | Explicitly denied permissions. |
TierRole
Section titled “TierRole”One role’s permission state at a single tier.
| Field | Type | Description |
|---|---|---|
override | TierPermissions | Explicit state at this tier. |
inherited_allows | repeated string | Allows inherited from broader tiers. |
inherited_denials | repeated string | Denials inherited from broader tiers. |
role | chatto.api.v1.Role | Public role metadata. |
TierRoles
Section titled “TierRoles”Role permission matrix for one tier.
| Field | Type | Description |
|---|---|---|
applicable_permissions | repeated string | Permissions configurable at this tier. |
roles | repeated TierRole | Roles sorted by position. |
UserPermissionMatrix
Section titled “UserPermissionMatrix”Complete permission matrix for one user at the matching scopes.
| Field | Type | Description |
|---|---|---|
user_id | string | User ID. |
applicable_permissions | repeated string | Permissions rendered as rows. |
scopes | repeated PermissionMatrixScope | Scopes rendered as columns. |
cells | repeated PermissionMatrixCell | Sparse matrix cells. |
AdminRoomLayoutGroup
Section titled “AdminRoomLayoutGroup”Ordered room group returned after admin layout mutations.
| Field | Type | Description |
|---|---|---|
id | string | Stable room group ID. |
name | string | Display name. |
description | string | Public group description, when set. |
items | repeated AdminRoomLayoutItem | Mixed room/sidebar-link entries in sidebar order. |
can_create_room | bool | Whether the viewer can create rooms in this group. |
AdminRoomLayoutItem
Section titled “AdminRoomLayoutItem”One ordered sidebar item in an admin room group layout.
| Field | Type | Description |
|---|---|---|
item.room | chatto.api.v1.Room | Channel room entry. |
item.sidebar_link | chatto.api.v1.SidebarLink | Sidebar link entry. |
AdminRoomLayoutItemInput
Section titled “AdminRoomLayoutItemInput”One room or sidebar link reference in a move or order replacement.
| Field | Type | Description |
|---|---|---|
item.room_id | string | Channel room ID. |
item.sidebar_link_id | string | Sidebar link ID. |
Neighbor
Section titled “Neighbor”One server advertised in the public Neighbor directory.
| Field | Type | Description |
|---|---|---|
id | string | Stable opaque resource ID. |
origin | string | Canonical HTTP or HTTPS server origin. |
revision | string | Opaque revision required for update and delete requests. |
RegistrationSettings
Section titled “RegistrationSettings”Account creation settings. Admission applies to direct signup and new SSO accounts.
| Field | Type | Description |
|---|---|---|
admission | chatto.api.v1.AccountCreationPolicy | Effective policy. OPEN permits signup without an invitation. |
RegistrationSettingsUpdate
Section titled “RegistrationSettingsUpdate”Partial registration update. Unselected fields stay unchanged.
| Field | Type | Description |
|---|---|---|
admission | optional chatto.api.v1.AccountCreationPolicy | Unspecified or a selected absent value resets admission to OPEN. |
ServerConfig
Section titled “ServerConfig”Runtime-editable server settings.
| Field | Type | Description |
|---|---|---|
server_name | string | Server name for page titles. Empty means the default is used. |
description | string | Short server description for OG link-preview metadata. |
motd | string | Message of the day for the authenticated header. |
welcome_message | string | Welcome message shown on the login page. |
registration | RegistrationSettings | Settings for new self-service accounts. |
ExternalIdentityFlowKind
Section titled “ExternalIdentityFlowKind”Mode of a pending external identity confirmation flow.
| Name | Number | Description |
|---|---|---|
EXTERNAL_IDENTITY_FLOW_KIND_UNSPECIFIED | 0 | The flow kind was not specified. |
EXTERNAL_IDENTITY_FLOW_KIND_CREATE_ACCOUNT | 1 | Create a new passwordless account and link the provider identity. |
EXTERNAL_IDENTITY_FLOW_KIND_LINK_ACCOUNT | 2 | Link the provider identity to the authenticated account. |
UsernameChoiceAvailability
Section titled “UsernameChoiceAvailability”State of choosing a username during account creation. Only ALLOWED enables choice; creation still checks policy and input. Unknown states remain disabled.
| Name | Number | Description |
|---|---|---|
USERNAME_CHOICE_AVAILABILITY_UNSPECIFIED | 0 | No decision is supplied. This does not grant permission. |
USERNAME_CHOICE_AVAILABILITY_ALLOWED | 1 | The user can choose a username, subject to validation and uniqueness. |
USERNAME_CHOICE_AVAILABILITY_PROVIDER_MANAGED | 2 | The provider supplies the username; the server resolves collisions. |
PresenceStatus
Section titled “PresenceStatus”Availability used for private choices and effective public presence.
Public Offline reveals neither connection liveness nor whether the account selected “Appear Offline”. A saved Online, Away, or Do Not Disturb choice becomes public Offline when no device refreshes liveness.
| Name | Number | Description |
|---|---|---|
PRESENCE_STATUS_UNSPECIFIED | 0 | No presence status was specified. |
PRESENCE_STATUS_ONLINE | 1 | Online while at least one device refreshes liveness. |
PRESENCE_STATUS_AWAY | 2 | Away while at least one device refreshes liveness. |
PRESENCE_STATUS_DO_NOT_DISTURB | 3 | Do Not Disturb. A saved choice suppresses alerts even while disconnected. |
PRESENCE_STATUS_OFFLINE | 4 | No public live presence. As a saved choice, suppresses presence and typing. |
EffectivePermissionScopeKind
Section titled “EffectivePermissionScopeKind”Scope of effective authority. Channel scopes never include direct messages.
| Name | Number | Description |
|---|---|---|
EFFECTIVE_PERMISSION_SCOPE_KIND_UNSPECIFIED | 0 | No scope supplied. |
EFFECTIVE_PERMISSION_SCOPE_KIND_SERVER | 1 | Server authority or the default for channel rooms. |
EFFECTIVE_PERMISSION_SCOPE_KIND_GROUP | 2 | A channel room group. |
EFFECTIVE_PERMISSION_SCOPE_KIND_ROOM | 3 | One channel room. |
EFFECTIVE_PERMISSION_SCOPE_KIND_DM | 4 | Direct-message authority; membership is always required. |
RoomInvitationStatus
Section titled “RoomInvitationStatus”Current lifecycle state. Expiry does not extend when the invitation is read.
| Name | Number | Description |
|---|---|---|
ROOM_INVITATION_STATUS_UNSPECIFIED | 0 | No value description provided. |
ROOM_INVITATION_STATUS_PENDING | 1 | No value description provided. |
ROOM_INVITATION_STATUS_ACCEPTED | 2 | No value description provided. |
ROOM_INVITATION_STATUS_DECLINED | 3 | No value description provided. |
ROOM_INVITATION_STATUS_EXPIRED | 4 | No value description provided. |
ImageFitMode
Section titled “ImageFitMode”Fit mode used when generating transformed image URLs.
| Name | Number | Description |
|---|---|---|
IMAGE_FIT_MODE_UNSPECIFIED | 0 | The fit mode was not specified. |
IMAGE_FIT_MODE_CONTAIN | 1 | Preserve the whole source image within the requested bounds. |
IMAGE_FIT_MODE_COVER | 2 | Fill the requested bounds, cropping when needed. |
RoomThreadingMode
Section titled “RoomThreadingMode”Policy governing thread creation and reply placement in a channel room. Direct-message rooms do not support threads and use UNSPECIFIED.
| Name | Number | Description |
|---|---|---|
ROOM_THREADING_MODE_UNSPECIFIED | 0 | No mode was supplied. CreateRoom treats this as ENABLED so older stored rooms and omitted request fields preserve Chatto’s default behavior. |
ROOM_THREADING_MODE_REQUIRED | 1 | Every new root message establishes a thread, and replies to root messages must be posted in that root’s thread. |
ROOM_THREADING_MODE_ENCOURAGED | 2 | Clients should steer replies into threads, but the server accepts both threaded and ordinary in-room replies. |
ROOM_THREADING_MODE_ENABLED | 3 | Threads are available and clients may freely choose whether to use them. |
ROOM_THREADING_MODE_DISABLED | 4 | New threads, thread replies, and channel echoes are rejected. Existing threads and echoes remain readable and ordinary in-room reply attribution remains available. |
MessageVideoProcessingStatus
Section titled “MessageVideoProcessingStatus”Processing state for a video attachment.
| Name | Number | Description |
|---|---|---|
MESSAGE_VIDEO_PROCESSING_STATUS_UNSPECIFIED | 0 | The processing status was not specified. |
MESSAGE_VIDEO_PROCESSING_STATUS_PROCESSING | 1 | Video processing is still running. |
MESSAGE_VIDEO_PROCESSING_STATUS_COMPLETED | 2 | Video processing completed successfully. |
MESSAGE_VIDEO_PROCESSING_STATUS_FAILED | 3 | Video processing failed. |
RoomKind
Section titled “RoomKind”Kind of room represented by the public API.
| Name | Number | Description |
|---|---|---|
ROOM_KIND_UNSPECIFIED | 0 | The room kind was not specified. |
ROOM_KIND_CHANNEL | 1 | A regular channel governed by server and room permissions. |
ROOM_KIND_DM | 2 | A direct-message conversation between members. |
RoomArchiveFilter
Section titled “RoomArchiveFilter”Archive state to include in room directory responses.
| Name | Number | Description |
|---|---|---|
ROOM_ARCHIVE_FILTER_UNSPECIFIED | 0 | Include active rooms only. |
ROOM_ARCHIVE_FILTER_ACTIVE | 1 | Include active rooms only. |
ROOM_ARCHIVE_FILTER_ARCHIVED | 2 | Include archived rooms only. |
ROOM_ARCHIVE_FILTER_ALL | 3 | Include both active and archived rooms. |
RoomDirectoryScope
Section titled “RoomDirectoryScope”Room kinds to include in directory responses.
| Name | Number | Description |
|---|---|---|
ROOM_DIRECTORY_SCOPE_UNSPECIFIED | 0 | Include visible channel rooms and the caller’s DM rooms. |
ROOM_DIRECTORY_SCOPE_ALL | 1 | Include visible channel rooms and the caller’s DM rooms. |
ROOM_DIRECTORY_SCOPE_CHANNELS | 2 | Include visible channel rooms only. |
ROOM_DIRECTORY_SCOPE_DMS | 3 | Include the caller’s DM rooms only. |
AccountCreationPolicy
Section titled “AccountCreationPolicy”Policy controlling whether self-service account creation requires an invitation.
| Name | Number | Description |
|---|---|---|
ACCOUNT_CREATION_POLICY_UNSPECIFIED | 0 | Compatibility value used by older servers. Clients treat it as open. |
ACCOUNT_CREATION_POLICY_OPEN | 1 | Self-service account creation does not require an invitation. |
ACCOUNT_CREATION_POLICY_INVITE_ONLY | 2 | Every self-service account creation path requires a valid invitation. |
DisconnectEligibility
Section titled “DisconnectEligibility”State of disconnecting a linked identity. Only ALLOWED enables the action. UNSPECIFIED means not evaluated; older-server fallbacks may use account state. Unknown future states remain disabled. This does not replace fresh authentication or the mutation’s eligibility check.
| Name | Number | Description |
|---|---|---|
DISCONNECT_ELIGIBILITY_UNSPECIFIED | 0 | Eligibility was not evaluated, including responses from older servers. |
DISCONNECT_ELIGIBILITY_ALLOWED | 1 | Another enabled sign-in method would remain. |
DISCONNECT_ELIGIBILITY_LAST_ENABLED_SIGN_IN_METHOD | 2 | Disconnecting would leave no enabled sign-in method. |
DISCONNECT_ELIGIBILITY_DISABLED_BY_OPERATOR | 3 | The operator disabled user-initiated unlinking for this provider. |
AccountDeletionAvailability
Section titled “AccountDeletionAvailability”State of self-service account deletion. Only ALLOWED enables the action; commands still check authority and authentication.
| Name | Number | Description |
|---|---|---|
ACCOUNT_DELETION_AVAILABILITY_UNSPECIFIED | 0 | No decision is supplied. This does not grant permission. |
ACCOUNT_DELETION_AVAILABILITY_ALLOWED | 1 | The user can attempt to start account deletion. |
ACCOUNT_DELETION_AVAILABILITY_PERMISSION_DENIED | 2 | The viewer lacks permission to delete this account. |
ACCOUNT_DELETION_AVAILABILITY_UNSUPPORTED_ACCOUNT | 3 | This account type does not support self-service deletion. |
PasswordChangeAvailability
Section titled “PasswordChangeAvailability”State of setting or changing a password. Only ALLOWED enables the action; commands still validate passwords and authentication.
| Name | Number | Description |
|---|---|---|
PASSWORD_CHANGE_AVAILABILITY_UNSPECIFIED | 0 | No decision is supplied. This does not grant permission. |
PASSWORD_CHANGE_AVAILABILITY_ALLOWED | 1 | The user can attempt to set or change a password. |
PASSWORD_CHANGE_AVAILABILITY_DIRECT_LOGIN_DISABLED | 2 | The operator disabled direct login and password self-service. |
PASSWORD_CHANGE_AVAILABILITY_UNSUPPORTED_ACCOUNT | 3 | This account type does not support password self-service. |
UsernameChangeAvailability.State
Section titled “UsernameChangeAvailability.State”State of username self-service, including its primary blocking condition.
| Name | Number | Description |
|---|---|---|
STATE_UNSPECIFIED | 0 | No decision is supplied. This does not grant permission. |
STATE_ALLOWED | 1 | Policy permits a username change, subject to available_at. |
STATE_PROVIDER_MANAGED | 2 | A linked provider manages the username. |
TimeFormat
Section titled “TimeFormat”User preference for rendering times in clients.
| Name | Number | Description |
|---|---|---|
TIME_FORMAT_UNSPECIFIED | 0 | No explicit preference was stored. |
TIME_FORMAT_AUTO | 1 | Let the client choose based on locale and browser settings. |
TIME_FORMAT_12_HOUR | 2 | Render times using a 12-hour clock. |
TIME_FORMAT_24_HOUR | 3 | Render times using a 24-hour clock. |
AssetUploadStatus
Section titled “AssetUploadStatus”Upload lifecycle state for a room-scoped attachment upload.
| Name | Number | Description |
|---|---|---|
ASSET_UPLOAD_STATUS_UNSPECIFIED | 0 | The upload status was not specified. |
ASSET_UPLOAD_STATUS_OPEN | 1 | The upload accepts more chunks. |
ASSET_UPLOAD_STATUS_COMPLETED | 2 | The upload has been completed and produced an attachment asset. |
ASSET_UPLOAD_STATUS_CANCELLED | 3 | The upload was cancelled or expired. |
CredentialLastUsedState
Section titled “CredentialLastUsedState”Availability of best-effort credential last-use telemetry.
| Name | Number | Description |
|---|---|---|
CREDENTIAL_LAST_USED_STATE_UNSPECIFIED | 0 | The server did not return a last-use state. |
CREDENTIAL_LAST_USED_STATE_NO_USE_RECORDED | 1 | The server has no recorded use for the credential. |
CREDENTIAL_LAST_USED_STATE_RECORDED | 2 | last_used_at contains the most recent recorded authentication time. |
CREDENTIAL_LAST_USED_STATE_UNAVAILABLE | 3 | Last-use telemetry is temporarily unavailable. |
ThreadOrder
Section titled “ThreadOrder”Ordering for followed threads. Equal dates use a stable thread identity order.
| Name | Number | Description |
|---|---|---|
THREAD_ORDER_UNSPECIFIED | 0 | Use newest activity first. |
THREAD_ORDER_ACTIVITY | 1 | Use newest activity first. |
THREAD_ORDER_CREATED | 2 | Use newest root-message creation first. Unknown creation dates come last. |
ThreadRootAuthorFilter
Section titled “ThreadRootAuthorFilter”Selects threads by the author of their root message, not their replies.
| Name | Number | Description |
|---|---|---|
THREAD_ROOT_AUTHOR_FILTER_UNSPECIFIED | 0 | Include all root authors. |
THREAD_ROOT_AUTHOR_FILTER_VIEWER | 1 | Include only roots authored by the authenticated viewer. |
THREAD_ROOT_AUTHOR_FILTER_OTHERS | 2 | Include only roots authored by other users. |
MessageSearchGroupBy
Section titled “MessageSearchGroupBy”Determines the result type and pagination unit.
| Name | Number | Description |
|---|---|---|
MESSAGE_SEARCH_GROUP_BY_UNSPECIFIED | 0 | Return individual matching messages. |
MESSAGE_SEARCH_GROUP_BY_THREAD | 1 | Return distinct thread rows. A root without replies is also a thread. |
MessageSearchOrder
Section titled “MessageSearchOrder”Ordering for message or grouped-thread search results.
| Name | Number | Description |
|---|---|---|
MESSAGE_SEARCH_ORDER_UNSPECIFIED | 0 | Use relevance order. |
MESSAGE_SEARCH_ORDER_RELEVANCE | 1 | Highest message score first; grouped results use their best matching message. |
MESSAGE_SEARCH_ORDER_NEWEST | 2 | Newest matching message first, also when results are grouped. |
MESSAGE_SEARCH_ORDER_THREAD_ACTIVITY | 3 | Return threads with the most recent activity first. Requires thread grouping. |
MESSAGE_SEARCH_ORDER_THREAD_CREATED | 4 | Newest root-message creation first, with unknown dates last. Requires thread grouping. Older servers can reject this order. |
MessageSearchScope
Section titled “MessageSearchScope”Candidate scope, intersected with the caller’s current access and query filters.
| Name | Number | Description |
|---|---|---|
MESSAGE_SEARCH_SCOPE_UNSPECIFIED | 0 | Search all accessible messages. This is the existing default. |
MESSAGE_SEARCH_SCOPE_FOLLOWED_THREADS | 1 | Search roots and replies in followed threads, including direct messages. |
MessageSearchState
Section titled “MessageSearchState”Current availability of message search on this server.
| Name | Number | Description |
|---|---|---|
MESSAGE_SEARCH_STATE_UNSPECIFIED | 0 | The server did not report a meaningful state. |
MESSAGE_SEARCH_STATE_DISABLED | 1 | Search is disabled by the server operator. |
MESSAGE_SEARCH_STATE_STARTING | 2 | Search is enabled but its provider has not established index state yet. |
MESSAGE_SEARCH_STATE_INDEXING | 3 | The provider is rebuilding or catching up and cannot answer queries yet. |
MESSAGE_SEARCH_STATE_READY | 4 | Search is ready to answer queries. |
MESSAGE_SEARCH_STATE_DEGRADED | 5 | Search can answer queries but has a known non-fatal limitation. |
MESSAGE_SEARCH_STATE_UNAVAILABLE | 6 | Search is enabled but no provider can currently answer. |
NotificationAttentionLevel
Section titled “NotificationAttentionLevel”Visual importance of an unread notification. This is independent from whether the notification is eligible for sound or push delivery.
| Name | Number | Description |
|---|---|---|
NOTIFICATION_ATTENTION_LEVEL_UNSPECIFIED | 0 | No attention level was provided. |
NOTIFICATION_ATTENTION_LEVEL_AMBIENT | 1 | Ambient activity appears with a neutral unread indicator. |
NOTIFICATION_ATTENTION_LEVEL_IMPORTANT | 2 | Important activity appears with Chatto’s notification orange. |
NotificationDeliveryMode
Section titled “NotificationDeliveryMode”Delivery behavior for one notification signal class.
| Name | Number | Description |
|---|---|---|
NOTIFICATION_DELIVERY_MODE_UNSPECIFIED | 0 | No delivery mode was specified. This value is not a valid override. |
NOTIFICATION_DELIVERY_MODE_OFF | 1 | Matching activity does not create user attention. |
NOTIFICATION_DELIVERY_MODE_SILENT | 2 | Deprecated alias for NOTIFICATION_DELIVERY_MODE_IN_APP_NOTIFICATION. |
NOTIFICATION_DELIVERY_MODE_IN_APP_NOTIFICATION | 2 | Matching activity creates an in-app notification but does not send push. |
NOTIFICATION_DELIVERY_MODE_ALERT | 3 | Deprecated alias for NOTIFICATION_DELIVERY_MODE_PUSH_NOTIFICATION. |
NOTIFICATION_DELIVERY_MODE_PUSH_NOTIFICATION | 3 | Matching activity creates an in-app notification and may send push. |
NOTIFICATION_DELIVERY_MODE_UNREAD_BADGE | 4 | Matching activity adds a neutral unread indicator without creating a notification occurrence, playing a sound, or sending push. |
CallMediaPublisherKind
Section titled “CallMediaPublisherKind”Native companion publisher kind.
| Name | Number | Description |
|---|---|---|
CALL_MEDIA_PUBLISHER_KIND_UNSPECIFIED | 0 | The publisher kind was not specified. |
CALL_MEDIA_PUBLISHER_KIND_GAME_SHARE | 1 | Native game-window video and application audio. |
AdminAssetCleanupHealth
Section titled “AdminAssetCleanupHealth”Operator-facing state for the shared durable asset cleanup queue.
| Name | Number | Description |
|---|---|---|
ADMIN_ASSET_CLEANUP_HEALTH_UNSPECIFIED | 0 | No value description provided. |
ADMIN_ASSET_CLEANUP_HEALTH_INACTIVE | 1 | No value description provided. |
ADMIN_ASSET_CLEANUP_HEALTH_INITIALIZING | 2 | No value description provided. |
ADMIN_ASSET_CLEANUP_HEALTH_HEALTHY | 3 | No value description provided. |
ADMIN_ASSET_CLEANUP_HEALTH_RETRYING | 4 | No value description provided. |
ADMIN_ASSET_CLEANUP_HEALTH_STALLED | 5 | No value description provided. |
ADMIN_ASSET_CLEANUP_HEALTH_UNAVAILABLE | 6 | Cleanup diagnostics could not be read; other system diagnostics remain valid. |
AdminDurableWorkerHealth
Section titled “AdminDurableWorkerHealth”Operator-facing state derived from a durable consumer.
| Name | Number | Description |
|---|---|---|
ADMIN_DURABLE_WORKER_HEALTH_UNSPECIFIED | 0 | No value description provided. |
ADMIN_DURABLE_WORKER_HEALTH_INACTIVE | 1 | This optional worker is not required by current server configuration. |
ADMIN_DURABLE_WORKER_HEALTH_HEALTHY | 2 | A worker is waiting and all known work is acknowledged. |
ADMIN_DURABLE_WORKER_HEALTH_WORKING | 3 | A worker is available and unacknowledged work remains. |
ADMIN_DURABLE_WORKER_HEALTH_UNCONFIRMED | 4 | An acknowledgement is pending, but broker state cannot prove whether a handler is active or the delivery is awaiting recovery after a crash. |
ADMIN_DURABLE_WORKER_HEALTH_STALLED | 5 | The consumer exists but has neither a waiting pull nor an ack-pending delivery. |
ADMIN_DURABLE_WORKER_HEALTH_UNAVAILABLE | 6 | The required consumer is unavailable. |
AdminLiveKitConnectionState
Section titled “AdminLiveKitConnectionState”Result of the LiveKit server API check.
| Name | Number | Description |
|---|---|---|
ADMIN_LIVE_KIT_CONNECTION_STATE_UNSPECIFIED | 0 | Unknown state. |
ADMIN_LIVE_KIT_CONNECTION_STATE_NOT_CONFIGURED | 1 | LiveKit is not configured, so Chatto did not do the check. |
ADMIN_LIVE_KIT_CONNECTION_STATE_OK | 2 | LiveKit accepted the API call with the configured key and secret. |
ADMIN_LIVE_KIT_CONNECTION_STATE_UNREACHABLE | 3 | Chatto could not connect to the LiveKit server URL. |
ADMIN_LIVE_KIT_CONNECTION_STATE_UNAUTHORIZED | 4 | LiveKit rejected the configured API key or secret. |
ADMIN_LIVE_KIT_CONNECTION_STATE_ERROR | 5 | The server at the URL replied with an unexpected error. |
InvitationCodeStatus
Section titled “InvitationCodeStatus”Current state of a single-use registration code.
| Name | Number | Description |
|---|---|---|
INVITATION_CODE_STATUS_UNSPECIFIED | 0 | No value description provided. |
INVITATION_CODE_STATUS_ACTIVE | 1 | No value description provided. |
INVITATION_CODE_STATUS_EXPIRED | 2 | No value description provided. |
INVITATION_CODE_STATUS_USED | 3 | No value description provided. |
INVITATION_CODE_STATUS_REVOKED | 4 | No value description provided. |
OauthClientPolicy
Section titled “OauthClientPolicy”Administrator policy for a public OAuth client. Trusted is an informational blessing and never bypasses individual user consent.
| Name | Number | Description |
|---|---|---|
OAUTH_CLIENT_POLICY_UNSPECIFIED | 0 | No valid policy was supplied. |
OAUTH_CLIENT_POLICY_DEFAULT | 1 | The client follows the normal open-client authorization policy. |
OAUTH_CLIENT_POLICY_TRUSTED | 2 | Administrators have labelled the client as trusted without changing consent. |
OAUTH_CLIENT_POLICY_BLOCKED | 3 | The client cannot authorize or use its existing OAuth access tokens. |
OauthClientSource
Section titled “OauthClientSource”How a public OAuth client establishes its identity with this server.
| Name | Number | Description |
|---|---|---|
OAUTH_CLIENT_SOURCE_UNSPECIFIED | 0 | The server does not recognize the source value. |
OAUTH_CLIENT_SOURCE_CIMD | 1 | The client identifies itself with an HTTPS Client ID Metadata Document. |
OAUTH_CLIENT_SOURCE_BUILT_IN | 2 | The client uses a registration built into this Chatto release. |
PermissionDecision
Section titled “PermissionDecision”Trinary permission decision used by permission matrices and write requests.
| Name | Number | Description |
|---|---|---|
PERMISSION_DECISION_UNSPECIFIED | 0 | Unspecified decision; rejected for writes. |
PERMISSION_DECISION_ALLOW | 1 | Explicit allow. |
PERMISSION_DECISION_DENY | 2 | Explicit deny. |
PERMISSION_DECISION_NONE | 3 | No explicit decision; clears the permission state on writes. |
PermissionDecisionLevel
Section titled “PermissionDecisionLevel”Level at which a permission explanation found a decision.
| Name | Number | Description |
|---|---|---|
PERMISSION_DECISION_LEVEL_UNSPECIFIED | 0 | No decision level was reached. |
PERMISSION_DECISION_LEVEL_SERVER | 1 | Server-level role or user decision. |
PERMISSION_DECISION_LEVEL_GROUP | 2 | Room-group-level role or user decision. |
PERMISSION_DECISION_LEVEL_ROOM | 3 | Room-level role or user decision. |
PERMISSION_DECISION_LEVEL_DM | 4 | Direct-message-level role or user decision. |
PermissionScopeKind
Section titled “PermissionScopeKind”Scope tier for permission matrices and write requests.
| Name | Number | Description |
|---|---|---|
PERMISSION_SCOPE_KIND_UNSPECIFIED | 0 | Unspecified scope; treated as server scope where older clients omit it. |
PERMISSION_SCOPE_KIND_SERVER | 1 | Server tier. |
PERMISSION_SCOPE_KIND_GROUP | 2 | Room-group tier. |
PERMISSION_SCOPE_KIND_ROOM | 3 | Room tier. |
PERMISSION_SCOPE_KIND_DM | 4 | Server-wide direct-message tier. |