java.lang.Object
java.lang.Enum<OptionType>
net.dv8tion.jda.api.interactions.commands.OptionType
All Implemented Interfaces:
Serializable, Comparable<OptionType>

public enum OptionType extends Enum<OptionType>
The available types for Command options.
  • Enum Constant Details

    • UNKNOWN

      public static final OptionType UNKNOWN
      Placeholder for future option types
    • SUB_COMMAND

      public static final OptionType SUB_COMMAND
    • SUB_COMMAND_GROUP

      public static final OptionType SUB_COMMAND_GROUP
    • STRING

      public static final OptionType STRING
    • INTEGER

      public static final OptionType INTEGER
    • BOOLEAN

      public static final OptionType BOOLEAN
    • USER

      public static final OptionType USER
    • CHANNEL

      public static final OptionType CHANNEL
    • ROLE

      public static final OptionType ROLE
    • MENTIONABLE

      public static final OptionType MENTIONABLE
    • NUMBER

      public static final OptionType NUMBER
  • Method Details

    • values

      public static OptionType[] 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 OptionType 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 raw value for this type or -1 for UNKNOWN
      Returns:
      The raw value
    • canSupportChoices

      public boolean canSupportChoices()
      Whether options of this type support predefined choices.
      Returns:
      True, if you can use choices for this type.
    • fromKey

      @Nonnull public static OptionType fromKey(int key)
      Converts the provided raw type to the enum constant.
      Parameters:
      key - The raw type
      Returns:
      The OptionType constant or UNKNOWN