Annotation Interface CommandOption

@Retention(RUNTIME) @Target({}) public @interface CommandOption
Defines a command option for slash commands.

Example:

@SlashCommand(
    name = "ban",
    description = "Ban a user",
    options = {
        @CommandOption(name = "user", description = "User to ban", type = OptionType.USER, required = true),
        @CommandOption(name = "reason", description = "Ban reason", type = OptionType.STRING, required = false)
    }
)
public void ban(SlashCommandInteractionEvent event) {
    // ...
}

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    description
     
    String
    name
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    autocomplete
     
    Choice[]
    choices
     
    double
    max
     
    double
    min
     
    boolean
    required
     
    net.dv8tion.jda.api.interactions.commands.OptionType
    type
    Integrated type of Option used for auto-complete when performed.

  • Element Details

    • name

      String name
      Returns:
      name of option.

    • description

      String description
      Returns:
      description of option.

    • type

      net.dv8tion.jda.api.interactions.commands.OptionType type
      Integrated type of Option used for auto-complete when performed.

      Use JDA's OptionType enum, for example: STRING, INTEGER, BOOLEAN, USER, CHANNEL, ROLE, MENTIONABLE, NUMBER, ATTACHMENT

      Returns:
      OptionType passed to the handler. Default OptionType.STRING
      Default:
      STRING

    • required

      boolean required
      Returns:
      Whether this option is required. Default Boolean.FALSE
      Default:
      false

    • choices

      Choice[] choices
      Returns:
      Array of predefined choices for this option. Default empty array.
      Default:
      {}

    • min

      double min
      Returns:
      Minimum value (for INTEGER and NUMBER types). Default Double.MIN_VALUE
      Default:
      4.9E-324

    • max

      double max
      Returns:
      Maximum value (for INTEGER and NUMBER types). Default Double.MAX_VALUE
      Default:
      1.7976931348623157E308

    • autocomplete

      boolean autocomplete
      Returns:
      Whether this option supports auto-completion. Default Boolean.FALSE
      Default:
      false