Preview environment

interface GatewayActivity

export interface GatewayActivity

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

optional
application_id? : Snowflake

Application id for the game

optional
assets? : GatewayActivityAssets

Images for the presence and their hover texts

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

optional
buttons? : GatewayActivityButton[] | string[]

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

created_at : number

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

optional
details? : string | null

What the player is currently doing

optional
emoji? : GatewayActivityEmoji

The emoji used for a custom status

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

optional
flags? : ActivityFlags

Activity flags ORd together, describes what the payload includes

See also: https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flagshttps://en.wikipedia.org/wiki/Bit_field

id : string

The activity's id

optional
instance? : boolean

Whether or not the activity is an instanced game session

name : string

The activity's name

optional
party? : GatewayActivityParty

Information for the current party of the player

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

optional
platform? : string

The platform this activity is being done on You can use ActivityPlatform as a stepping stone, but this might be inaccurate

optional
secrets? : GatewayActivitySecrets

Secrets for Rich Presence joining and spectating

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

optional
session_id? : string

optional
state? : string | null

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

optional
sync_id? : string

The Spotify song id

optional
timestamps? : GatewayActivityTimestamps

Unix timestamps for start and/or end of the game

type : ActivityType

Activity type

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

optional
url? : string | null

Stream url, is validated when type is 1