Package discord4j.core.object.presence

Enum Status

java.lang.Object

java.lang.Enum<Status>

discord4j.core.object.presence.Status

All Implemented Interfaces:

Serializable, Comparable<Status>

public enum Status
extends Enum<Status>

Represents the various type of status. See Status Types

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Status.Platform

Enum Constant Summary

Enum Constants

Enum Constant	Description
DO_NOT_DISTURB
IDLE
INVISIBLE
OFFLINE
ONLINE
UNKNOWN

Method Summary

Modifier and Type	Method	Description
String	getValue()	Gets the underlying value as represented by Discord.
static Status	of(String value)	Gets the type of status.
static Status	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Status[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final Status UNKNOWN

ONLINE

public static final Status ONLINE

DO_NOT_DISTURB

public static final Status DO_NOT_DISTURB

IDLE

public static final Status IDLE

INVISIBLE

public static final Status INVISIBLE

OFFLINE

public static final Status OFFLINE

Method Detail

values

public static Status[] 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 (Status c : Status.values())
    System.out.println(c);

Returns:

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

valueOf

public static Status 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

getValue

public String getValue()

Gets the underlying value as represented by Discord.

Returns:

The underlying value as represented by Discord.

of

public static Status of(String value)

Gets the type of status. It is guaranteed that invoking getValue() from the returned enum will equal (Enum.equals(Object)) the supplied value.

Parameters:

value - The underlying value as represented by Discord.

Returns:

The type of status.