Package net.dv8tion.jda.api.entities

Enum Activity.ActivityType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Activity.ActivityType>
    Enclosing interface:
    Activity
    public static enum Activity.ActivityType
extends java.lang.Enum<Activity.ActivityType>
    The type game being played, differentiating between a game and stream types.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      COMPETING
      Used to indicate that the Activity should display as Competing in... in the official client.
      CUSTOM_STATUS
      Used to indicate that the Activity should display as a custom status in the official client.
      DEFAULT
      The ActivityType used to represent a normal Activity status.
      LISTENING
      Used to indicate that the Activity should display as Listening... in the official client.
      STREAMING
      Used to indicate that the Activity is a stream
      This type is displayed as "Streaming" in the discord client.
      WATCHING
      Used to indicate that the Activity should display as Watching... in the official client.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Activity.ActivityType fromKey​(int key)
      Gets the ActivityType related to the provided key.
      int getKey()
      The Discord defined id key for this ActivityType.
      static Activity.ActivityType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Activity.ActivityType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • STREAMING

        public static final Activity.ActivityType STREAMING
        Used to indicate that the Activity is a stream
        This type is displayed as "Streaming" in the discord client.

      • LISTENING

        public static final Activity.ActivityType LISTENING
        Used to indicate that the Activity should display as Listening... in the official client.

      • WATCHING

        @Incubating
public static final Activity.ActivityType WATCHING
        Used to indicate that the Activity should display as Watching... in the official client.
        Incubating:
        This feature is not yet confirmed for the official bot API

      • CUSTOM_STATUS

        @Incubating
public static final Activity.ActivityType CUSTOM_STATUS
        Used to indicate that the Activity should display as a custom status in the official client.
        Incubating:
        This Activity type is read-only for bots

      • COMPETING

        public static final Activity.ActivityType COMPETING
        Used to indicate that the Activity should display as Competing in... in the official client.
        Since:
        4.2.1

    • Method Detail

      • values

        public static Activity.ActivityType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Activity.ActivityType c : Activity.ActivityType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Activity.ActivityType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getKey

        public int getKey()
        The Discord defined id key for this ActivityType.
        Returns:
        the id key.

      • fromKey

        @Nonnull
public static Activity.ActivityType fromKey​(int key)
        Gets the ActivityType related to the provided key.
        If an unknown key is provided, this returns DEFAULT
        Parameters:
        key - The Discord key referencing a ActivityType.
        Returns:
        The ActivityType that has the key provided, or DEFAULT for unknown key.