Results

Namespace

Type

An object describing an ongoing activity.

This data is usually used to display the "Currently Playing" data on the user card in the Discord client.

It also contains any other relevant Rich Presence data, if any exists.

All fields are nullable except the name and type.

Hierarchy

  • IActivity <-- You are here!

Index

Properties

Readonly applicationId

applicationId: Snowflake | null

The application id (game id) this activity is associated with.

Readonly assets

assets: IActivityAssets | null

An object containing any relevant image urls used for Rich Presence popups.

Readonly createdAt

createdAt: Date | null

The date this activity started.

Readonly details

details: string | null

What the player is currently doing.

Readonly emoji

emoji: IActivityEmoji | null

The data for the Emoji used for the user's custom status, if set.

Readonly flags

flags: ActivityFlags | null

A bit set of flags that describe what Rich Presence actions can be performed on this activity.

Readonly instance

instance: boolean

true if the activity is an instanced game session.

Readonly name

name: string

The name of the game or activity.

Readonly party

party: IActivityParty | null

The activity's party information.

Readonly secrets

secrets: IActivitySecrets | null

An object containing secrets for Rich Presence joining and spectating.

Readonly state

state: string | null

The user's current party status.

Readonly timestamps

timestamps: IActivityTimestamps | null

An object containing start and end time for this activity.

Readonly type

The type of activity this is.

Readonly url

url: string | null

A url for this activity, typically a url to a stream if the activity is a STREAMING.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc