Package de.jcm.discordgamesdk.user

Enum Class OnlineStatus

java.lang.Object

java.lang.Enum<OnlineStatus>

de.jcm.discordgamesdk.user.OnlineStatus

All Implemented Interfaces:

Serializable, Comparable<OnlineStatus>, Constable

public enum OnlineStatus
extends Enum<OnlineStatus>

The Discord status of a user (usually part of their Presence).

See Also:

• https://discordapp.com/developers/docs/game-sdk/relationships#data-models-status-enum

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DO_NO_DISTURB	The user has enabled the DND (do not disturb) mode.
IDLE	The user is AFK or in idle mode.
OFFLINE	The user is offline.
ONLINE	The user is online.

Method Summary

Modifier and Type	Method	Description
static OnlineStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OnlineStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OFFLINE

public static final OnlineStatus OFFLINE

The user is offline.

ONLINE

public static final OnlineStatus ONLINE

The user is online.

IDLE

public static final OnlineStatus IDLE

The user is AFK or in idle mode.

DO_NO_DISTURB

public static final OnlineStatus DO_NO_DISTURB

The user has enabled the DND (do not disturb) mode.

Method Details

values

public static OnlineStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OnlineStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null