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

Enum OptionType

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 Summary

Enum Constants

Enum Constant	Description
ATTACHMENT	Options which accept a file attachment
BOOLEAN	Options which accept boolean true or false inputs
CHANNEL	Options which accept a single GuildChannel
INTEGER	Options which accept Long integer inputs
MENTIONABLE	Options which accept a single Role, User, or Member.
NUMBER	Options which accept a Double value (also includes Long)
ROLE	Options which accept a single Role
STRING	Options which accept text inputs.
SUB_COMMAND	Option which is serialized as subcommand, this is only used for internals and should be ignored by users.
SUB_COMMAND_GROUP	Option which is serialized as subcommand groups, this is only used for internals and should be ignored by users.
UNKNOWN	Placeholder for future option types
USER	Options which accept a single Member or User

Method Summary

Modifier and Type	Method	Description
boolean	canSupportChoices()	Whether options of this type support predefined choices.
static OptionType	fromKey(int key)	Converts the provided raw type to the enum constant.
int	getKey()	The raw value for this type or -1 for UNKNOWN
static OptionType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static OptionType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final OptionType UNKNOWN

Placeholder for future option types

SUB_COMMAND

public static final OptionType SUB_COMMAND

Option which is serialized as subcommand, this is only used for internals and should be ignored by users.

See Also:

• SlashCommandData.addSubcommands(SubcommandData...)

SUB_COMMAND_GROUP

public static final OptionType SUB_COMMAND_GROUP

Option which is serialized as subcommand groups, this is only used for internals and should be ignored by users.

See Also:

• SlashCommandData.addSubcommandGroups(SubcommandGroupData...)

STRING

public static final OptionType STRING

Options which accept text inputs. This also supports role/channel/user mentions.

See Also:

• OptionMapping.getAsString()
• OptionMapping.getMentions()

INTEGER

public static final OptionType INTEGER

Options which accept Long integer inputs

See Also:

• OptionMapping.getAsLong()

BOOLEAN

public static final OptionType BOOLEAN

Options which accept boolean true or false inputs

See Also:

• OptionMapping.getAsBoolean()

USER

public static final OptionType USER

Options which accept a single Member or User

See Also:

• OptionMapping.getAsUser()
• OptionMapping.getAsMember()

CHANNEL

public static final OptionType CHANNEL

Options which accept a single GuildChannel

See Also:

• OptionMapping.getAsChannel()

ROLE

public static final OptionType ROLE

Options which accept a single Role

See Also:

• OptionMapping.getAsRole()

MENTIONABLE

public static final OptionType MENTIONABLE

Options which accept a single Role, User, or Member.

See Also:

• OptionMapping.getAsMentionable()

NUMBER

public static final OptionType NUMBER

Options which accept a Double value (also includes Long)

See Also:

• OptionMapping.getAsDouble()
• OptionMapping.getAsLong()

ATTACHMENT

public static final OptionType ATTACHMENT

Options which accept a file attachment

See Also:

• OptionMapping.getAsAttachment()

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