Package net.dv8tion.jda.api

Enum OnlineStatus

java.lang.Object
java.lang.Enum<OnlineStatus>
net.dv8tion.jda.api.OnlineStatus
All Implemented Interfaces:
Serializable, Comparable<OnlineStatus>
public enum OnlineStatus extends Enum<OnlineStatus>
Represents the online presence of a Member.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DO_NOT_DISTURB
    Indicates that the user is currently on do not disturb (red circle)
    This means the user won't receive notifications for mentions.
    IDLE
    Indicates that the user is currently idle (orange circle)
    INVISIBLE
    Indicates that the currently logged in account is set to invisible and shows up as OFFLINE for other users.
    OFFLINE
    Indicates that a member is currently offline or invisible (grey circle)
    ONLINE
    Indicates that the user is currently online (green circle)
    UNKNOWN
    Placeholder for possible future online status values that are not listed here yet.

  • Method Summary

    Modifier and Type
    Method
    Description
    static OnlineStatus
    fromKey(String key)
    Will get the OnlineStatus from the provided key.
    String
    getKey()
    The valid API key for this OnlineStatus
    static OnlineStatus
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static OnlineStatus[]
    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 Details

    • ONLINE

      public static final OnlineStatus ONLINE
      Indicates that the user is currently online (green circle)

    • IDLE

      public static final OnlineStatus IDLE
      Indicates that the user is currently idle (orange circle)

    • DO_NOT_DISTURB

      public static final OnlineStatus DO_NOT_DISTURB
      Indicates that the user is currently on do not disturb (red circle)
      This means the user won't receive notifications for mentions.

    • INVISIBLE

      public static final OnlineStatus INVISIBLE
      Indicates that the currently logged in account is set to invisible and shows up as OFFLINE for other users.
      Only available for the currently logged in account.
      Other Members will show up as OFFLINE even when they really are INVISIBLE.

    • OFFLINE

      public static final OnlineStatus OFFLINE
      Indicates that a member is currently offline or invisible (grey circle)

    • UNKNOWN

      public static final OnlineStatus UNKNOWN
      Placeholder for possible future online status values that are not listed here yet.

  • Method Details

    • values

      public static OnlineStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static OnlineStatus valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getKey

      @Nonnull public String getKey()
      The valid API key for this OnlineStatus
      Returns:
      String representation of the valid API key for this OnlineStatus
      See Also:

    • fromKey

      @Nonnull public static OnlineStatus fromKey(@Nonnull String key)
      Will get the OnlineStatus from the provided key.
      If the provided key does not have a matching OnlineStatus, this will return UNKONWN
      Parameters:
      key - The key relating to the OnlineStatus we wish to retrieve.
      Returns:
      The matching OnlineStatus. If there is no match, returns UNKNOWN.