Payload Types

Payload Structures

This page documents the core data structures (payloads) used throughout the OnRabbleClient application. These payloads represent both chat content and internal system entities, and are typically deserialized from JSON messages received via WebSocket or HTTP responses.

Chat Payloads

These payloads represent user-visible messages exchanged in public and private channels.

• ChatMessagePayload — Represents a single public chat message posted to a channel.
• PrivateMessagePayload — Represents a one-to-one private message between users.

System Payloads

These payloads describe the state of the application, including server discovery and channel definitions.

• ChannelPayload — Represents metadata for a named chat channel.
• DiscoveryPayload — Describes the endpoints returned from a discovery lookup.
• ClientUserPayload — Represents the identity of an authenticated user.
• UserStatusPayload — Represents another users status (e.g. username, id, and connection status)