Package net.dv8tion.jda.core.entities

Class RichPresence

java.lang.Object

net.dv8tion.jda.core.entities.Game

net.dv8tion.jda.core.entities.RichPresence

public class RichPresence
extends Game

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

Since:

3.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
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
static class	RichPresence.Timestamps	Represents the start and end timestamps for a running match

Nested classes/interfaces inherited from class net.dv8tion.jda.core.entities.Game

Game.GameType

Method Summary

Modifier and Type	Method	Description
RichPresence	asRichPresence()	RichPresence representation of this Game.
boolean	equals(java.lang.Object o)
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.
int	hashCode()
boolean	isRich()	Whether this is a Rich Presence If false the result of Game.asRichPresence() is null
java.lang.String	toString()

Methods inherited from class net.dv8tion.jda.core.entities.Game

getName, getTimestamps, getType, getUrl, isValidStreamingUrl, listening, of, of, playing, streaming, watching

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

isRich

public boolean isRich()

Description copied from class: Game

Whether this is a Rich Presence
If false the result of Game.asRichPresence() is null

Overrides:

isRich in class Game

Returns:

true if this is a RichPresence

asRichPresence

public RichPresence asRichPresence()

Description copied from class: Game

RichPresence representation of this Game.

Overrides:

asRichPresence in class Game

Returns:

RichPresence or null if Game.isRich() returns false

getApplicationIdLong

public long getApplicationIdLong()

The ID for the responsible application.

Returns:

The ID for the application

getApplicationId

@Nonnull
public java.lang.String getApplicationId()

The ID for the responsible application.

Returns:

The ID for the application

getSessionId

@Nullable
public java.lang.String getSessionId()

Session ID for this presence.
Used by spotify integration.

Returns:

Session ID

getSyncId

@Nullable
public java.lang.String getSyncId()

Sync ID for this presence.
Used by spotify integration.

Returns:

Sync ID

getFlags

public int getFlags()

Flags for this presence

Returns:

The flags for this presence

See Also:

ActivityFlag, ActivityFlag.getFlags(int)

getFlagSet

public 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
public 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
public 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
public RichPresence.Party getParty()

Information on the active party of the player

Returns:

Party wrapper or null if unset

getLargeImage

@Nullable
public RichPresence.Image getLargeImage()

Information on the large image displayed in the profile view

Returns:

Image wrapper or null if unset

getSmallImage

@Nullable
public RichPresence.Image getSmallImage()

Information on the small corner image displayed in the profile view

Returns:

Image wrapper or null if unset

toString

public java.lang.String toString()

Overrides:

toString in class Game

hashCode

public int hashCode()

Overrides:

hashCode in class Game

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Game