Interface ShardEmbedStatusResponse

Public embed status (net occupancy without auth).

interface ShardEmbedStatusResponse {
    connected: number;
    guildId: string;
    guildName: string;
    nets: {
        id: number;
        name: string;
        netUid?: string;
        occupancy: number;
        protected?: boolean;
        public?: boolean;
        uid?: string;
        virtual?: boolean;
    }[];
    ok: boolean;
    operationOpen: boolean;
    publicNet: {
        enabled: boolean;
        id: number;
        name: string;
        netUid: string;
        occupancy: number;
        uid: string;
    };
    updatedAt: string;
}

Properties

connected guildId guildName nets ok operationOpen publicNet updatedAt

Properties

connected

connected: number

Number of connected operators.

guildId

guildId: string

Discord guild ID this shard serves.

guildName

guildName: string

Human-readable guild name.

nets

nets: {
    id: number;
    name: string;
    netUid?: string;
    occupancy: number;
    protected?: boolean;
    public?: boolean;
    uid?: string;
    virtual?: boolean;
}[]

Summary of each net's occupancy and visibility.

Type declaration

  • id: number

    Numeric net ID.

  • name: string

    Net name.

  • OptionalnetUid?: string

    Alternate net UID.

  • occupancy: number

    Number of operators currently on the net.

  • Optionalprotected?: boolean

    Whether the net is protected.

  • Optionalpublic?: boolean

    Whether the net is publicly visible.

  • Optionaluid?: string

    Stable net UID.

  • Optionalvirtual?: boolean

    Whether the net is virtual.

ok

ok: boolean

Whether the embed status query succeeded.

operationOpen

operationOpen: boolean

Whether the operation is currently open.

publicNet

publicNet: {
    enabled: boolean;
    id: number;
    name: string;
    netUid: string;
    occupancy: number;
    uid: string;
}

The primary public net and its occupancy.

Type declaration

  • enabled: boolean

    Whether the net is enabled.

  • id: number

    Numeric net ID.

  • name: string

    Net name.

  • netUid: string

    Alternate net UID.

  • occupancy: number

    Number of operators currently on the net.

  • uid: string

    Stable net UID.

updatedAt

updatedAt: string

ISO timestamp when the status was last updated.

Settings

Member Visibility

On This Page

Properties