Interface GatewayActivity

See

https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-structure

interface GatewayActivity {
    application_id?: string;
    assets?: Partial<
        Record<
            | "large_image"
            | "large_text"
            | "large_url"
            | "small_image"
            | "small_text"
            | "small_url",
            string,
        >,
    >;
    buttons?: string[]
    | GatewayActivityButton[];
    created_at: number;
    details?: null | string;
    details_url?: null | string;
    emoji?: GatewayActivityEmoji;
    flags?: ActivityFlags;
    id: string;
    instance?: boolean;
    name: string;
    party?: GatewayActivityParty;
    platform?: string;
    secrets?: Partial<Record<"match" | "join" | "spectate", string>>;
    session_id?: string;
    state?: null | string;
    state_url?: null | string;
    status_display_type?: null | StatusDisplayType;
    sync_id?: string;
    timestamps?: GatewayActivityTimestamps;
    type: ActivityType;
    url?: null | string;
}

Properties

application_id? assets? buttons? created_at details? details_url? emoji? flags? id instance? name party? platform? secrets? session_id? state? state_url? status_display_type? sync_id? timestamps? type url?

Properties

Optionalapplication_id

application_id?: string

Application id for the game

Optionalassets

assets?: Partial<
    Record<
        | "large_image"
        | "large_text"
        | "large_url"
        | "small_image"
        | "small_text"
        | "small_url",
        string,
    >,
>

Images for the presence and their hover texts

See

https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets

Optionalbuttons

buttons?: string[] | GatewayActivityButton[]

The custom buttons shown in the Rich Presence (max 2)

created_at

created_at: number

Unix timestamp of when the activity was added to the user's session

Optionaldetails

details?: null | string

What the player is currently doing

Optionaldetails_url

details_url?: null | string

URL that is linked when clicking on the details text

Optionalemoji

emoji?: GatewayActivityEmoji

The emoji used for a custom status

See

https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji

Optionalflags

flags?: ActivityFlags

Activity flags ORd together, describes what the payload includes

See

id

id: string

The activity's id

Unstable

Optionalinstance

instance?: boolean

Whether or not the activity is an instanced game session

name

name: string

The activity's name

Optionalparty

party?: GatewayActivityParty

Information for the current party of the player

See

https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party

Optionalplatform

platform?: string

The platform this activity is being done on

Unstable

You can use ActivityPlatform as a stepping stone, but this might be inaccurate

Optionalsecrets

secrets?: Partial<Record<"match" | "join" | "spectate", string>>

Secrets for Rich Presence joining and spectating

See

https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets

Optionalsession_id

session_id?: string

Unstable

Optionalstate

state?: null | string

The user's current party status, or the text used for a custom status

Optionalstate_url

state_url?: null | string

URL that is linked when clicking on the state text

Optionalstatus_display_type

status_display_type?: null | StatusDisplayType

Controls which field is displayed in the user's status text in the member list

See

https://discord.com/developers/docs/events/gateway-events#activity-object-status-display-types

Optionalsync_id

sync_id?: string

The Spotify song id

Unstable

Optionaltimestamps

timestamps?: GatewayActivityTimestamps

Unix timestamps for start and/or end of the game

type

type: ActivityType

Activity type

See

https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types

Optionalurl

url?: null | string

Stream url, is validated when type is 1

Settings

Member Visibility

On This Page

Properties