Package net.dv8tion.jda.core

Enum OnlineStatus

java.lang.Object

java.lang.Enum<OnlineStatus>

net.dv8tion.jda.core.OnlineStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OnlineStatus>

public enum OnlineStatus
extends java.lang.Enum<OnlineStatus>

Represents the online presence of a Member or Friend.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DO_NOT_DISTURB
IDLE
INVISIBLE
OFFLINE
ONLINE
UNKNOWN

Method Summary

Modifier and Type	Method	Description
static OnlineStatus	fromKey(java.lang.String key)	Will get the OnlineStatus from the provided key.
java.lang.String	getKey()	The valid API key for this OnlineStatus
static OnlineStatus	valueOf(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.

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

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(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 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 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.