Package net.dv8tion.jda.api.entities

Enum ScheduledEvent.Status

java.lang.Object

java.lang.Enum<ScheduledEvent.Status>

net.dv8tion.jda.api.entities.ScheduledEvent.Status

All Implemented Interfaces:

Serializable, Comparable<ScheduledEvent.Status>

Enclosing interface:

ScheduledEvent

public static enum ScheduledEvent.Status
extends Enum<ScheduledEvent.Status>

Represents the status of a scheduled event.

See Also:

• ScheduledEvent.getStatus()

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE
CANCELED
COMPLETED
SCHEDULED
UNKNOWN

Method Summary

Modifier and Type	Method	Description
static ScheduledEvent.Status	fromKey(int key)	Used to retrieve a Status based on a Discord id key.
int	getKey()	The Discord id key for this Status.
static ScheduledEvent.Status	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ScheduledEvent.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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final ScheduledEvent.Status UNKNOWN

SCHEDULED

public static final ScheduledEvent.Status SCHEDULED

ACTIVE

public static final ScheduledEvent.Status ACTIVE

COMPLETED

public static final ScheduledEvent.Status COMPLETED

CANCELED

public static final ScheduledEvent.Status CANCELED

Method Details

values

public static ScheduledEvent.Status[] values()

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

Returns:

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

valueOf

public static ScheduledEvent.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

getKey

public int getKey()

The Discord id key for this Status.

Returns:

The id key for this Status

fromKey

@Nonnull
public static ScheduledEvent.Status fromKey(int key)

Used to retrieve a Status based on a Discord id key.

Parameters:

key - The Discord id key representing the requested Status.

Returns:

The Status related to the provided key, or Status.UNKNOWN if the key is not recognized.