Skip to main content

DiscordActivity

Documentation


Documentation / @discordeno/types / DiscordActivity

Interface: DiscordActivity

Defined in: discord/gateway.ts:848

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

Properties

application_id?

optional application_id?: string

Defined in: discord/gateway.ts:860

Application id for the game


assets?

optional assets?: DiscordActivityAssets

Defined in: discord/gateway.ts:876

Images for the presence and their hover texts


buttons?

optional buttons?: DiscordActivityButton[]

Defined in: discord/gateway.ts:884

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


created_at

created_at: number

Defined in: discord/gateway.ts:856

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


details?

optional details?: string | null

Defined in: discord/gateway.ts:864

What the player is currently doing


details_url?

optional details_url?: string | null

Defined in: discord/gateway.ts:866

URL that is linked when clicking on the details text


emoji?

optional emoji?: DiscordActivityEmoji | null

Defined in: discord/gateway.ts:872

The emoji used for a custom status


flags?

optional flags?: number

Defined in: discord/gateway.ts:882

Activity flags ORd together, describes what the payload includes


instance?

optional instance?: boolean

Defined in: discord/gateway.ts:880

Whether or not the activity is an instanced game session


name

name: string

Defined in: discord/gateway.ts:850

The activity's name


party?

optional party?: DiscordActivityParty

Defined in: discord/gateway.ts:874

Information for the current party of the player


secrets?

optional secrets?: DiscordActivitySecrets

Defined in: discord/gateway.ts:878

Secrets for Rich Presence joining and spectating


state?

optional state?: string | null

Defined in: discord/gateway.ts:868

The user's current party status


state_url?

optional state_url?: string | null

Defined in: discord/gateway.ts:870

URL that is linked when clicking on the state text


status_display_type?

optional status_display_type?: DiscordStatusDisplayType | null

Defined in: discord/gateway.ts:862

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


timestamps?

optional timestamps?: DiscordActivityTimestamps

Defined in: discord/gateway.ts:858

Unix timestamps for start and/or end of the game


type

type: ActivityTypes

Defined in: discord/gateway.ts:852

Activity type


url?

optional url?: string | null

Defined in: discord/gateway.ts:854

Stream url, is validated when type is 1