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 aMember
.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static OnlineStatus
fromKey(String key)
Will get theOnlineStatus
from the provided key.String
getKey()
The valid API key for this OnlineStatusstatic 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.
-
-
-
Enum Constant Detail
-
ONLINE
public static final OnlineStatus ONLINE
-
IDLE
public static final OnlineStatus IDLE
-
DO_NOT_DISTURB
public static final OnlineStatus DO_NOT_DISTURB
-
INVISIBLE
public static final OnlineStatus INVISIBLE
-
OFFLINE
public static final OnlineStatus OFFLINE
-
UNKNOWN
public static final OnlineStatus UNKNOWN
-
-
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(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 nameNullPointerException
- if the argument is null
-
getKey
public 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(String key)
Will get theOnlineStatus
from the provided key.
If the provided key does not have a matching OnlineStatus, this will returnUNKONWN
- Parameters:
key
- The key relating to theOnlineStatus
we wish to retrieve.- Returns:
- The matching
OnlineStatus
. If there is no match, returnsUNKNOWN
.
-
-