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 Details

  • 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.