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

Class Command.Option

java.lang.Object

net.dv8tion.jda.api.interactions.commands.Command.Option

Enclosing class:

Command

public static class Command.Option
extends Object

An Option for a command.

Constructor Summary

Constructors

Constructor	Description
Option(DataObject json)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Set<ChannelType>	getChannelTypes()	The ChannelTypes this option is restricted to.
List<Command.Choice>	getChoices()	The predefined choices available for this option.
String	getDescription()	The description of this option, subcommand, or subcommand group.
Number	getMaxValue()	The maximum value which can be provided for this option.
Number	getMinValue()	The minimum value which can be provided for this option.
String	getName()	The name of this option, subcommand, or subcommand group.
OptionType	getType()	The OptionType.
int	getTypeRaw()	The raw option type.
int	hashCode()
boolean	isRequired()	Whether this option is required
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Option

public Option(@Nonnull
              DataObject json)

Method Detail

getName

@Nonnull
public String getName()

The name of this option, subcommand, or subcommand group.

Returns:

The name

getDescription

@Nonnull
public String getDescription()

The description of this option, subcommand, or subcommand group.

Returns:

The description

getTypeRaw

public int getTypeRaw()

The raw option type.

Returns:

The type

isRequired

public boolean isRequired()

Whether this option is required

Returns:

True if this option is required

getType

@Nonnull
public OptionType getType()

The OptionType.

Returns:

The type

getChannelTypes

@Nonnull
public Set<ChannelType> getChannelTypes()

The ChannelTypes this option is restricted to.
This is empty if the option is not of type CHANNEL or not restricted to specific types.

Returns:

Immutable Set of ChannelType

getMinValue

@Nullable
public Number getMinValue()

The minimum value which can be provided for this option.
This returns null if the value is not set or if the option is not of type INTEGER or NUMBER.

Returns:

The minimum value for this option or null

getMaxValue

@Nullable
public Number getMaxValue()

The maximum value which can be provided for this option.
This returns null if the value is not set or if the option is not of type INTEGER or NUMBER.

Returns:

The maximum value for this option or null

getChoices

@Nonnull
public List<Command.Choice> getChoices()

The predefined choices available for this option.
If no choices are defined, this returns an empty list.

Returns:

Immutable List of Command.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