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, JDA jda, Guild guild)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Message.Attachment	getAsAttachment()	The file uploaded for this option.
boolean	getAsBoolean()	The boolean value.
GuildChannelUnion	getAsChannel()	The resolved GuildChannel for this option value.
double	getAsDouble()	The double value for this option.
int	getAsInt()	The int value for this option.
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.
Role	getAsRole()	The resolved Role for this option value.
String	getAsString()	The String representation of this option value.
User	getAsUser()	The resolved User for this option value.
ChannelType	getChannelType()	The ChannelType for the resolved channel.
Mentions	getMentions()	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,
 JDA jda,
 Guild guild)

Method Details

getMentions

@Nonnull
public Mentions getMentions()

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

Mentioned members and roles are always of the same guild. If the interaction user, mentions users from other guilds, they will only be provided by Mentions.getUsers().

This is not supported for CommandAutoCompleteInteraction.

Returns:

Mentions for this 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

getAsAttachment

@Nonnull
public Message.Attachment getAsAttachment()

The file uploaded for this option.
This is represented as an ephemeral attachment which will only be hosted for up to 2 weeks. If you want a permanent reference, you must download it.

Returns:

Attachment

Throws:

IllegalStateException - If this option type is not OptionType.ATTACHMENT

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

getAsInt

public int getAsInt()

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

It is highly recommended to assert int values by using OptionData.setRequiredRange(long, long)

Returns:

The int 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

ArithmeticException - If the provided integer value cannot fit into a 32bit signed int

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

getAsChannel

@Nonnull
public GuildChannelUnion getAsChannel()

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

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