Package net.dv8tion.jda.api.entities

Enum ScheduledEvent.Type

java.lang.Object

java.lang.Enum<ScheduledEvent.Type>

net.dv8tion.jda.api.entities.ScheduledEvent.Type

All Implemented Interfaces:

Serializable, Comparable<ScheduledEvent.Type>

Enclosing interface:

ScheduledEvent

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

Represents what type of event an event is, or where the event will be taking place at.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXTERNAL	An event held externally.
STAGE_INSTANCE	An event with it's own StageInstance
UNKNOWN	Unknown future types that may be added by Discord which aren't represented in JDA yet.
VOICE	An event inside a VoiceChannel

Method Summary

Modifier and Type	Method	Description
static ScheduledEvent.Type	fromKey(int key)	Used to retrieve a Type based on a Discord id key.
int	getKey()	The Discord id key used to represent the scheduled event type.
boolean	isChannel()	Whether the event is scheduled to be held in a GuildChannel.
static ScheduledEvent.Type	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ScheduledEvent.Type[]	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.Type UNKNOWN

Unknown future types that may be added by Discord which aren't represented in JDA yet.

STAGE_INSTANCE

public static final ScheduledEvent.Type STAGE_INSTANCE

An event with it's own StageInstance

VOICE

public static final ScheduledEvent.Type VOICE

An event inside a VoiceChannel

EXTERNAL

public static final ScheduledEvent.Type EXTERNAL

An event held externally.

Method Details

values

public static ScheduledEvent.Type[] 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.Type 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 used to represent the scheduled event type.

Returns:

The id key used by discord for this scheduled event type.

isChannel

public boolean isChannel()

Whether the event is scheduled to be held in a GuildChannel.

Returns:

True, if the event is scheduled to be held in a GuildChannel

fromKey

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

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

Parameters:

key - The Discord id key representing the requested Type.

Returns:

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