Interface LocalSnapshot

Top-level snapshot message sent by the local client on connection and on state changes.

interface LocalSnapshot {
    access: LocalAccess;
    activeGuildId: string;
    activeNetId: number;
    admin?: LocalAdmin;
    app: string;
    channels: LocalChannel[];
    connected: boolean;
    displayName: string;
    guildId: string;
    guildName: string;
    operationOpen: boolean;
    overlay: LocalOverlay;
    pairedDevices: number;
    protocol: string;
    protocolVersion: number;
    ptt: LocalPtt;
    receiving: LocalReceivingEntry[];
    relay: LocalRelay;
    socketStatus: string;
    type: "snapshot";
    userId: string;
    version: string;
}

Properties

access: LocalAccess

User access/permission flags.

activeGuildId: string

Identifier of the currently active guild.

activeNetId: number

Identifier of the currently active net.

admin?: LocalAdmin

Admin-only session data, present only for admin users.

app: string

Name of the local application.

channels: LocalChannel[]

Channels/nets visible to the local user.

connected: boolean

Whether the local client is currently connected.

displayName: string

Display name of the current user.

guildId: string

Identifier of the current guild.

guildName: string

Display name of the current guild.

operationOpen: boolean

Whether an operation is currently open.

overlay: LocalOverlay

Overlay display state.

pairedDevices: number

Number of paired devices.

protocol: string

Name of the protocol in use.

protocolVersion: number

Numeric version of the protocol.

Current push-to-talk state.

receiving: LocalReceivingEntry[]

Entries currently being received (others transmitting).

relay: LocalRelay

Relay/shard connection state.

socketStatus: string

Current status of the underlying socket.

type: "snapshot"

Message discriminant identifying this as a snapshot message.

userId: string

Identifier of the current user.

version: string

Version string of the local application.