Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GatewayActivity

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

Hierarchy

  • GatewayActivity

Index

Properties

Properties

Optional application_id

application_id?: string

Application id for the game

Optional assets

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

Images for the presence and their hover texts

Optional buttons

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

Optional details

details?: null | string

What the player is currently doing

Optional emoji

emoji?: GatewayActivityEmoji

The emoji used for a custom status

Optional flags

flags?: ActivityFlags

Activity flags ORd together, describes what the payload includes

id

id: string

The activity's id

unstable

Optional instance

instance?: boolean

Whether or not the activity is an instanced game session

name

name: string

The activity's name

Optional party

party?: GatewayActivityParty

Information for the current party of the player

Optional platform

platform?: string

The platform this activity is being done on

unstable

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

Optional secrets

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

Secrets for Rich Presence joining and spectating

Optional session_id

session_id?: string
unstable

Optional state

state?: null | string

The user's current party status

Optional sync_id

sync_id?: string

The Spotify song id

unstable

Optional timestamps

timestamps?: GatewayActivityTimestamps

Unix timestamps for start and/or end of the game

type

type: ActivityType

Activity type

Optional url

url?: null | string

Stream url, is validated when type is 1

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:16 AM