GatewayActivity

@see

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

Index

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

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

id

unstable

id: string

The activity's id

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

unstable

platform?: string

The platform this activity is being done on

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

optionalsecrets

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

Secrets for Rich Presence joining and spectating

@see

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

optionalsession_id

unstable

session_id?: string

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

unstable

sync_id?: string

The Spotify song id

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