Package net.dv8tion.jda.api.entities

Interface RichPresence

All Superinterfaces:

Activity

public interface RichPresence
extends Activity

Used to hold additional information about a users Activity relevant to Rich Presence.

Since:

3.4.0

See Also:

Activity.asRichPresence()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RichPresence.Image	Used to hold information on images within a Rich Presence profile
static class	RichPresence.Party	Holds information on a player's party

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.Activity

Activity.ActivityType, Activity.Emoji, Activity.Timestamps

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.Activity

STREAMING_URL

Method Summary

Modifier and Type	Method	Description
java.lang.String	getApplicationId()	The ID for the responsible application.
long	getApplicationIdLong()	The ID for the responsible application.
java.lang.String	getDetails()	What the player is currently doing Example: "Competitive - Captain's Mode", "In Queue", "Unranked PvP"
int	getFlags()	Flags for this presence
java.util.EnumSet<ActivityFlag>	getFlagSet()	Flags for this presence in an enum set
RichPresence.Image	getLargeImage()	Information on the large image displayed in the profile view
RichPresence.Party	getParty()	Information on the active party of the player
java.lang.String	getSessionId()	Session ID for this presence.
RichPresence.Image	getSmallImage()	Information on the small corner image displayed in the profile view
java.lang.String	getState()	The user's current party status Example: "Looking to Play", "Playing Solo", "In a Group"
java.lang.String	getSyncId()	Sync ID for this presence.

Methods inherited from interface net.dv8tion.jda.api.entities.Activity

asRichPresence, getEmoji, getName, getTimestamps, getType, getUrl, isRich

Method Detail

getApplicationIdLong

long getApplicationIdLong()

The ID for the responsible application.

Returns:

The ID for the application

getApplicationId

@Nonnull
java.lang.String getApplicationId()

The ID for the responsible application.

Returns:

The ID for the application

getSessionId

@Nullable
java.lang.String getSessionId()

Session ID for this presence.
Used by spotify integration.

Returns:

Session ID

getSyncId

@Nullable
java.lang.String getSyncId()

Sync ID for this presence.
Used by spotify integration.

Returns:

Sync ID

getFlags

int getFlags()

Flags for this presence

Returns:

The flags for this presence

See Also:

ActivityFlag, ActivityFlag.getFlags(int)

getFlagSet

java.util.EnumSet<ActivityFlag> getFlagSet()

Flags for this presence in an enum set

Returns:

The flags for this presence

See Also:

ActivityFlag, ActivityFlag.getFlags(int)

getState

@Nullable
java.lang.String getState()

The user's current party status
Example: "Looking to Play", "Playing Solo", "In a Group"

Returns:

The user's current party status

getDetails

@Nullable
java.lang.String getDetails()

What the player is currently doing
Example: "Competitive - Captain's Mode", "In Queue", "Unranked PvP"

Returns:

What the player is currently doing

getParty

@Nullable
RichPresence.Party getParty()

Information on the active party of the player

Returns:

Party wrapper or null if unset

getLargeImage

@Nullable
RichPresence.Image getLargeImage()

Information on the large image displayed in the profile view

Returns:

Image wrapper or null if unset

getSmallImage

@Nullable
RichPresence.Image getSmallImage()

Information on the small corner image displayed in the profile view

Returns:

Image wrapper or null if unset