Package net.dv8tion.jda.api.entities
Enum ScheduledEvent.Status
- All Implemented Interfaces:
Serializable
,Comparable<ScheduledEvent.Status>
- Enclosing interface:
- ScheduledEvent
Represents the status of a scheduled event.
- See Also:
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionstatic 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
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.
-
Enum Constant Details
-
UNKNOWN
-
SCHEDULED
-
ACTIVE
-
COMPLETED
-
CANCELED
-
-
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 for this Status.- Returns:
- The id key for this Status
-
fromKey
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.
-