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

Class OptionMapping

java.lang.Object

net.dv8tion.jda.api.interactions.commands.OptionMapping

public class OptionMapping
extends Object

Name/Value pair for a CommandInteraction option.

Since values for command options are a union-type you can use this class to coerce the values to the desired target type.
You can use getType() to do dynamic handling as well. Each getter documents the conditions and coercion rules for the specific types.

See Also:

• CommandInteractionPayload.getOption(String)
• CommandInteractionPayload.getOptions()

Constructor Summary

Constructors

Constructor	Description
OptionMapping(DataObject data, gnu.trove.map.TLongObjectMap<Object> resolved)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
AudioChannel	getAsAudioChannel()	The resolved AudioChannel for this option value.
boolean	getAsBoolean()	The boolean value.
double	getAsDouble()	The double value for this option.
GuildChannel	getAsGuildChannel()	The resolved GuildChannel for this option value.
long	getAsLong()	The long value for this option.
Member	getAsMember()	The resolved Member for this option value.
IMentionable	getAsMentionable()	The resolved IMentionable instance for this option value.
GuildMessageChannel	getAsMessageChannel()	The resolved GuildMessageChannel for this option value.
NewsChannel	getAsNewsChannel()	The resolved NewsChannel for this option value.
Role	getAsRole()	The resolved Role for this option value.
StageChannel	getAsStageChannel()	The resolved StageChannel for this option value.
String	getAsString()	The String representation of this option value.
TextChannel	getAsTextChannel()	The resolved TextChannel for this option value.
ThreadChannel	getAsThreadChannel()	The resolved ThreadChannel for this option value.
User	getAsUser()	The resolved User for this option value.
VoiceChannel	getAsVoiceChannel()	The resolved VoiceChannel for this option value.
ChannelType	getChannelType()	The ChannelType for the resolved channel.
List<GuildChannel>	getMentionedChannels()	Resolved GuildChannel mentions for a STRING option.
List<Member>	getMentionedMembers()	Resolved Member mentions for a STRING option.
List<Role>	getMentionedRoles()	Resolved Role mentions for a STRING option.
List<User>	getMentionedUsers()	Resolved User mentions for a STRING option.
List<IMentionable>	getMentions()	All resolved mentions for a STRING option.
String	getName()	The name of this option.
OptionType	getType()	The OptionType of this option.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OptionMapping

public OptionMapping(DataObject data,
 gnu.trove.map.TLongObjectMap<Object> resolved)

Method Details

getMentionedMembers

@Nonnull
public List<Member> getMentionedMembers()

Resolved Member mentions for a STRING option.
If this option is not of type STRING, this always returns an empty list. Mentions are sorted by occurrence.

This only contains members of the guild. If the user mentions users from other guilds, they will only be provided by getMentionedUsers().

This is not supported for CommandAutoCompleteInteraction.

Returns:

List of Member the resolved guild user mentions in a string option

getMentionedUsers

@Nonnull
public List<User> getMentionedUsers()

Resolved User mentions for a STRING option.
If this option is not of type STRING, this always returns an empty list. Mentions are sorted by occurrence.

This may also contain users which are not members in the guild!

This is not supported for CommandAutoCompleteInteraction.

Returns:

List of User the resolved guild user mentions in a string option

getMentionedRoles

@Nonnull
public List<Role> getMentionedRoles()

Resolved Role mentions for a STRING option.
If this option is not of type STRING, this always returns an empty list. Mentions are sorted by occurrence.

This is not supported for CommandAutoCompleteInteraction.

Returns:

List of Role the resolved guild role mentions in a string option

getMentionedChannels

@Nonnull
public List<GuildChannel> getMentionedChannels()

Resolved GuildChannel mentions for a STRING option.
If this option is not of type STRING, this always returns an empty list. Mentions are sorted by occurrence.

This is not supported for CommandAutoCompleteInteraction.

Returns:

List of GuildChannel the resolved guild channel mentions in a string option

getMentions

@Nonnull
public List<IMentionable> getMentions()

All resolved mentions for a STRING option.
If this option is not of type STRING, this always returns an empty list. Mentions are sorted by occurrence.

This is not supported for CommandAutoCompleteInteraction. This merges getMentionedUsers(), getMentionedMembers(), getMentionedRoles(), and getMentionedChannels().

Returns:

List of IMentionable the resolved mentions in a string option

getType

@Nonnull
public OptionType getType()

The OptionType of this option.

Returns:

The OptionType

getName

@Nonnull
public String getName()

The name of this option.

Returns:

The option name

getAsString

@Nonnull
public String getAsString()

The String representation of this option value.
This will automatically convert the value to a string if the type is not OptionType.STRING.
This will be the ID of any resolved entity such as Role or Member.

Returns:

The String representation of this option value

getAsBoolean

public boolean getAsBoolean()

The boolean value.

Returns:

The boolean value

Throws:

IllegalStateException - If this option is not of type BOOLEAN

getAsLong

public long getAsLong()

The long value for this option.
This will be the ID of any resolved entity such as Role or Member.

Returns:

The long value

Throws:

IllegalStateException - If this option type cannot be converted to a long

NumberFormatException - If this option is of type STRING and could not be parsed to a valid long value

getAsDouble

public double getAsDouble()

The double value for this option.

Returns:

The double value

Throws:

IllegalStateException - If this option type cannot be converted to a double

NumberFormatException - If this option is of type STRING and could not be parsed to a valid double value

getAsMentionable

@Nonnull
public IMentionable getAsMentionable()

The resolved IMentionable instance for this option value.

Returns:

The resolved IMentionable

Throws:

IllegalStateException - If the mentioned entity is not resolvable

getAsMember

@Nullable
public Member getAsMember()

The resolved Member for this option value.
Note that OptionType.USER can also accept users that are not members of a guild, in which case this will be null!

Returns:

The resolved Member, or null

Throws:

IllegalStateException - If this option is not of type USER or MENTIONABLE

getAsUser

@Nonnull
public User getAsUser()

The resolved User for this option value.

Returns:

The resolved User

Throws:

IllegalStateException - If this option is not of type USER or MENTIONABLE without a resolved user

getAsRole

@Nonnull
public Role getAsRole()

The resolved Role for this option value.

Returns:

The resolved Role

Throws:

IllegalStateException - If this option is not of type ROLE or MENTIONABLE without a resolved role

getChannelType

@Nonnull
public ChannelType getChannelType()

The ChannelType for the resolved channel.

Returns:

The ChannelType

Throws:

IllegalStateException - If this option is not of type CHANNEL

getAsGuildChannel

@Nonnull
public GuildChannel getAsGuildChannel()

The resolved GuildChannel for this option value.
Note that OptionType.CHANNEL can accept channels of any type!

Returns:

The resolved GuildChannel

Throws:

IllegalStateException - If this option is not of type CHANNEL or could not be resolved for unexpected reasons

getAsMessageChannel

@Nullable
public GuildMessageChannel getAsMessageChannel()

The resolved GuildMessageChannel for this option value.
Note that OptionType.CHANNEL can accept channels of any type!

Returns:

The resolved GuildMessageChannel, or null if this was not a message channel

Throws:

IllegalStateException - If this option is not of type CHANNEL

getAsTextChannel

@Nullable
public TextChannel getAsTextChannel()

The resolved TextChannel for this option value.
Note that OptionType.CHANNEL can accept channels of any type!

Returns:

The resolved TextChannel, or null if this was not a text channel

Throws:

IllegalStateException - If this option is not of type CHANNEL

getAsNewsChannel

@Nullable
public NewsChannel getAsNewsChannel()

The resolved NewsChannel for this option value.
Note that OptionType.CHANNEL can accept channels of any type!

Returns:

The resolved NewsChannel, or null if this was not a news channel

Throws:

IllegalStateException - If this option is not of type CHANNEL

getAsThreadChannel

@Nullable
public ThreadChannel getAsThreadChannel()

The resolved ThreadChannel for this option value.
Note that OptionType.CHANNEL can accept channels of any type!

Returns:

The resolved ThreadChannel, or null if this was not a thread channel

Throws:

IllegalStateException - If this option is not of type CHANNEL

getAsAudioChannel

@Nullable
public AudioChannel getAsAudioChannel()

The resolved AudioChannel for this option value.
Note that OptionType.CHANNEL can accept channels of any type!

Returns:

The resolved AudioChannel, or null if this was not an audio channel

Throws:

IllegalStateException - If this option is not of type CHANNEL

getAsVoiceChannel

@Nullable
public VoiceChannel getAsVoiceChannel()

The resolved VoiceChannel for this option value.
Note that OptionType.CHANNEL can accept channels of any type!

Returns:

The resolved VoiceChannel, or null if this was not a voice channel

Throws:

IllegalStateException - If this option is not of type CHANNEL

getAsStageChannel

@Nullable
public StageChannel getAsStageChannel()

The resolved StageChannel for this option value.
Note that OptionType.CHANNEL can accept channels of any type!

Returns:

The resolved StageChannel, or null if this was not a stage channel

Throws:

IllegalStateException - If this option is not of type CHANNEL

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object