RichPresence

classe · Source

Constructor

new RichPresence(client: Client, data?: RichPresence)

Parameters

Name	Type	Description
client	Client	Discord client
data?	RichPresence	RichPresence to clone or raw data Default: {}.

Methods

setup

private

setup(data: RichPresence)

Sets the status from a JSON object Parameters

Name	Type	Description
data	RichPresence	data
Source

setAssetsLargeImage

setAssetsLargeImage(image: RichPresenceImage): RichPresence

Set the large image of this activity Parameters

Name	Type	Description
image	RichPresenceImage	The large image asset's id

Returns: RichPresenceSource

setAssetsSmallImage

setAssetsSmallImage(image: RichPresenceImage): RichPresence

Set the small image of this activity Parameters

Name	Type	Description
image	RichPresenceImage	The small image asset's id

Returns: RichPresenceSource

setAssetsLargeText

setAssetsLargeText(text: string): RichPresence

Hover text for the large image Parameters

Name	Type	Description
text	string	Assets text

Returns: RichPresenceSource

setAssetsSmallText

setAssetsSmallText(text: string): RichPresence

Hover text for the small image Parameters

Name	Type	Description
text	string	Assets text

Returns: RichPresenceSource

setName

setName(name: string): RichPresence

Set the name of the activity Parameters

Name	Type	Description
name	string	The activity's name

Returns: RichPresenceSource

setURL

setURL(url: string): RichPresence

If the activity is being streamed, a link to the stream Parameters

Name	Type	Description
url	string	URL of the stream

Returns: RichPresenceSource

setType

setType(type: ActivityTypes): RichPresence

The activity status's type Parameters

Name	Type	Description
type	ActivityTypes	The type of activity

Returns: RichPresenceSource

setApplicationId

setApplicationId(id: Snowflake): RichPresence

Set the application id of this activity Parameters

Name	Type	Description
id	Snowflake	Bot's id

Returns: RichPresenceSource

setState

setState(state: string): RichPresence

Set the state of the activity Parameters

Name	Type	Description
state	string	The state of the activity

Returns: RichPresenceSource

setDetails

setDetails(details: string): RichPresence

Set the details of the activity Parameters

Name	Type	Description
details	string	The details of the activity

Returns: RichPresenceSource

setParty

setParty(party: RichParty): RichPresence

Set the party of this activity Parameters

Name	Type	Description
party	RichParty	The party to be displayed

Returns: RichPresenceSource

setStartTimestamp

setStartTimestamp(timestamp: Date | number | null): RichPresence

Sets the start timestamp of the activity Parameters

Name	Type	Description
timestamp	Date | number | null	The timestamp of the start of the activity

Returns: RichPresenceSource

setEndTimestamp

setEndTimestamp(timestamp: Date | number | null): RichPresence

Sets the end timestamp of the activity Parameters

Name	Type	Description
timestamp	Date | number | null	The timestamp of the end of the activity

Returns: RichPresenceSource

setButtons

setButtons(button: RichButton): RichPresence

Set the buttons of the rich presence Parameters

Name	Type	Description
button	RichButton	A list of buttons to set

Returns: RichPresenceSource

setPlatform

setPlatform(platform: ActivityPlatform | null): RichPresence

The platform the activity is being played on Parameters

Name	Type	Description
platform	ActivityPlatform | null	Any platform

Returns: RichPresenceSource

setJoinSecret

setJoinSecret(join: string): RichPresence

Secrets for rich presence joining and spectating (send-only) Parameters

Name	Type	Description
join	string	Secrets for rich presence joining

Returns: RichPresenceSource

addButton

addButton(name: string, url: string): RichPresence

Add a button to the rich presence Parameters

Name	Type	Description
name	string	The name of the button
url	string	The url of the button

Returns: RichPresenceSource

toJSON

toJSON(): Object

Convert the rich presence to a JSON object Returns: ObjectSource

toString

toString(): string

When concatenated with a string, this automatically returns the activities' name instead of the Activity object. Returns: stringSource

getExternal

static · async

async getExternal(client: Client, applicationId: Snowflake, images: string): Promise<Array<ExternalAssets>>

Retrieves external assets from a RichPresence Parameters

Name	Type	Description
client	Client	The Discord client instance.
applicationId	Snowflake	The application ID associated with the Rich Presence.
images	string	1 or 2 external image URLs (not hosted by Discord).

Returns: Promise<Array<ExternalAssets>>Source