Skip to main content
Version: Next

GatewayActivity

@deprecated

API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.

Index

Properties

optionalapplication_id

application_id?: string

Application id for the game

optionalassets

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

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

optionalemoji

optionalflags

id

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

optionalplatform

platform?: ActivityPlatform

optionalsecrets

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

optionalsession_id

session_id?: string

optionalstate

state?: null | string

The user’s current party status

optionalsync_id

sync_id?: string

optionaltimestamps

Unix timestamps for start and/or end of the game

type

optionalurl

url?: null | string

Stream url, is validated when type is 1