Package net.dv8tion.jda.api.interactions.commands

Class Command.Choice

java.lang.Object
net.dv8tion.jda.api.interactions.commands.Command.Choice
Enclosing interface:
Command
public static class Command.Choice extends Object
Predefined choice used for options.
See Also:

  • Constructor Details

    • Choice

      public Choice(@Nonnull String name, long value)
      Create a Choice tuple
      Parameters:
      name - The display name of this choice
      value - The integer value you receive in a command option

    • Choice

      public Choice(@Nonnull String name, double value)
      Create a Choice tuple
      Parameters:
      name - The display name of this choice
      value - The double value you receive in a command option

    • Choice

      public Choice(@Nonnull String name, @Nonnull String value)
      Create a Choice tuple
      Parameters:
      name - The display name of this choice
      value - The string value you receive in a command option

    • Choice

      public Choice(@Nonnull DataObject json)
      Create a Choice tuple
      Parameters:
      json - The serialized choice instance with name and value mapping
      Throws:
      IllegalArgumentException - If null is provided
      ParsingException - If the data is not formatted correctly or missing required parameters

  • Method Details

    • getName

      @Nonnull public String getName()
      The readable name of this choice.
      This is shown to the user in the official client.
      Returns:
      The choice name

    • getAsDouble

      public double getAsDouble()
      The value of this choice.
      Returns:
      The double value, or NaN if this is not a numeric choice value

    • getAsLong

      public long getAsLong()
      The value of this choice.
      Returns:
      The long value

    • getAsString

      @Nonnull public String getAsString()
      The value of this choice.
      Returns:
      The String value

    • getType

      @Nonnull public OptionType getType()
      The OptionType this choice is for
      Returns:
      The option type of this choice

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object