Package net.dv8tion.jda.api.entities
Enum ScheduledEvent.Type
- All Implemented Interfaces:
Serializable
,Comparable<ScheduledEvent.Type>
- Enclosing interface:
- ScheduledEvent
Represents what type of event an event is, or where the event will be taking place at.
-
Enum Constant Summary
Enum ConstantDescriptionAn event held externally.An event with it's ownStageInstance
Unknown future types that may be added by Discord which aren't represented in JDA yet.An event inside aVoiceChannel
-
Method Summary
Modifier and TypeMethodDescriptionstatic 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
Whether the event is scheduled to be held in aGuildChannel
.static ScheduledEvent.Type
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.
-
Enum Constant Details
-
UNKNOWN
Unknown future types that may be added by Discord which aren't represented in JDA yet. -
STAGE_INSTANCE
An event with it's ownStageInstance
-
VOICE
An event inside aVoiceChannel
-
EXTERNAL
An event held externally.
-
-
Method Details
-
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
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 nameNullPointerException
- 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 aGuildChannel
.- Returns:
- True, if the event is scheduled to be held in a
GuildChannel
-
fromKey
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.
-