Package net.dv8tion.jda.api.entities
Interface RichPresence
- All Superinterfaces:
Activity
Used to hold additional information about a users
Activity
relevant to Rich Presence.- Since:
- 3.4.0
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic class
Used to hold information on images within a Rich Presence profilestatic class
Holds information on a player's partyNested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.Activity
Activity.ActivityType, Activity.Timestamps
-
Field Summary
Fields inherited from interface net.dv8tion.jda.api.entities.Activity
MAX_ACTIVITY_NAME_LENGTH, MAX_ACTIVITY_STATE_LENGTH, STREAMING_URL
-
Method Summary
Modifier and TypeMethodDescriptionThe ID for the responsible application.long
The ID for the responsible application.What the player is currently doing
Example: "Competitive - Captain's Mode", "In Queue", "Unranked PvP"int
getFlags()
Flags for this presenceFlags for this presence in an enum setInformation on the large image displayed in the profile viewgetParty()
Information on the active party of the playerSession ID for this presence.Information on the small corner image displayed in the profile viewSync ID for this presence.Methods inherited from interface net.dv8tion.jda.api.entities.Activity
asRichPresence, getEmoji, getName, getState, getTimestamps, getType, getUrl, isRich, withState
-
Method Details
-
getApplicationIdLong
long getApplicationIdLong()The ID for the responsible application.- Returns:
- The ID for the application
-
getApplicationId
The ID for the responsible application.- Returns:
- The ID for the application
-
getSessionId
Session ID for this presence.
Used by spotify integration.- Returns:
- Session ID
-
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:
-
getFlagSet
Flags for this presence in an enum set- Returns:
- The flags for this presence
- See Also:
-
getDetails
What the player is currently doing
Example: "Competitive - Captain's Mode", "In Queue", "Unranked PvP"- Returns:
- What the player is currently doing
-
getParty
Information on the active party of the player- Returns:
Party
wrapper ornull
if unset
-
getLargeImage
Information on the large image displayed in the profile view- Returns:
Image
wrapper ornull
if unset
-
getSmallImage
Information on the small corner image displayed in the profile view- Returns:
Image
wrapper ornull
if unset
-