Package net.dv8tion.jda.api
Enum OnlineStatus
- java.lang.Object
-
- java.lang.Enum<OnlineStatus>
-
- net.dv8tion.jda.api.OnlineStatus
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<OnlineStatus>
public enum OnlineStatus extends java.lang.Enum<OnlineStatus>
Represents the online presence of aMember.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DO_NOT_DISTURBIndicates that the user is currently on do not disturb (red circle)
This means the user won't receive notifications for mentions.IDLEIndicates that the user is currently idle (orange circle)INVISIBLEIndicates that the currently logged in account is set to invisible and shows up asOFFLINEfor other users.OFFLINEIndicates that a member is currently offline or invisible (grey circle)ONLINEIndicates that the user is currently online (green circle)UNKNOWNPlaceholder for possible future online status values that are not listed here yet.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static OnlineStatusfromKey(java.lang.String key)Will get theOnlineStatusfrom the provided key.java.lang.StringgetKey()The valid API key for this OnlineStatusstatic OnlineStatusvalueOf(java.lang.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.
-
-
-
Enum Constant Detail
-
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
-
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 Detail
-
values
public static OnlineStatus[] 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 (OnlineStatus c : OnlineStatus.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static OnlineStatus 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 namejava.lang.NullPointerException- if the argument is null
-
getKey
public java.lang.String getKey()
The valid API key for this OnlineStatus- Returns:
- String representation of the valid API key for this OnlineStatus
- See Also:
- PRESENCE_UPDATE
-
fromKey
public static OnlineStatus fromKey(java.lang.String key)
Will get theOnlineStatusfrom the provided key.
If the provided key does not have a matching OnlineStatus, this will returnUNKONWN- Parameters:
key- The key relating to theOnlineStatuswe wish to retrieve.- Returns:
- The matching
OnlineStatus. If there is no match, returnsUNKNOWN.
-
-