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:

  • Method Details

    • getApplicationIdLong

      long getApplicationIdLong()
      The ID for the responsible application.
      Returns:
      The ID for the application

    • getApplicationId

      @Nonnull String getApplicationId()
      The ID for the responsible application.
      Returns:
      The ID for the application

    • getSessionId

      @Nullable String getSessionId()
      Session ID for this presence.
      Used by spotify integration.
      Returns:
      Session ID

    • getSyncId

      @Nullable 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:

    • getFlagSet

      EnumSet<ActivityFlag> getFlagSet()
      Flags for this presence in an enum set
      Returns:
      The flags for this presence
      See Also:

    • getDetails

      @Nullable 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