Package net.dv8tion.jda.api.interactions.modals

Interface ModalInteraction

All Superinterfaces:

ICustomIdInteraction, IDeferrableCallback, IMessageEditCallback, Interaction, IReplyCallback, ISnowflake

All Known Implementing Classes:

ModalInteractionEvent

public interface ModalInteraction
extends IReplyCallback, IMessageEditCallback, ICustomIdInteraction

Interaction on a Modal

If the modal of this interaction was a reply to a ComponentInteraction, you can also use IMessageEditCallback.deferEdit() to edit the original message that contained the component instead of replying.

See Also:

• ModalInteractionEvent

Method Summary

Modifier and Type	Method	Description
MessageChannelUnion	getChannel()	The channel this interaction happened in.
default String	getCustomId()	The relevant custom ID, that has been provided for the component or modal when it was originally created.
default GuildMessageChannelUnion	getGuildChannel()	The GuildChannel this interaction happened in.
Message	getMessage()	Message this modal came from, if it was a reply to a ComponentInteraction.
String	getModalId()	Returns the custom id of the Modal in question
default ModalMapping	getValue(String customId)	Convenience method to get a ModalMapping by its id from the List of ModalMappings
default ModalMapping	getValueByUniqueId(int id)	Convenience method to get a ModalMapping by its numeric id from the List of ModalMappings
@Unmodifiable List<ModalMapping>	getValues()	Returns a List of ModalMappings representing the values input by the user for each field when the modal was submitted.

Methods inherited from interface net.dv8tion.jda.api.interactions.callbacks.IDeferrableCallback

getHook

Methods inherited from interface net.dv8tion.jda.api.interactions.callbacks.IMessageEditCallback

deferEdit, editComponents, editComponents, editComponents, editMessage, editMessage, editMessageAttachments, editMessageAttachments, editMessageEmbeds, editMessageEmbeds, editMessageFormat

Methods inherited from interface net.dv8tion.jda.api.interactions.Interaction

getChannelId, getChannelIdLong, getChannelType, getContext, getEntitlements, getGuild, getGuildLocale, getIntegrationOwners, getJDA, getMember, getMessageChannel, getToken, getType, getTypeRaw, getUser, getUserLocale, isAcknowledged, isFromAttachedGuild, isFromGuild

Methods inherited from interface net.dv8tion.jda.api.interactions.callbacks.IReplyCallback

deferReply, deferReply, reply, reply, replyComponents, replyComponents, replyComponents, replyEmbeds, replyEmbeds, replyFiles, replyFiles, replyFormat, replyPoll

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Method Details

getCustomId

@Nonnull
default String getCustomId()

Description copied from interface: ICustomIdInteraction

The relevant custom ID, that has been provided for the component or modal when it was originally created.
This value should be used to determine what action to take in regard to this interaction.
This id does not have to be numerical.

Specified by:

getCustomId in interface ICustomIdInteraction

Returns:

The custom ID

See Also:

• ComponentInteraction.getComponentId()
• getModalId()

getModalId

@Nonnull
String getModalId()

Returns the custom id of the Modal in question

Returns:

Custom id

See Also:

• Modal.Builder.setId(String)

getValues

@Nonnull
@Unmodifiable List<ModalMapping> getValues()

Returns a List of ModalMappings representing the values input by the user for each field when the modal was submitted.

Returns:

Immutable List of ModalMappings

See Also:

• getValue(String)

getValue

@Nullable
default ModalMapping getValue(@Nonnull
 String customId)

Convenience method to get a ModalMapping by its id from the List of ModalMappings

Returns null if no component with that id has been found

Parameters:

customId - The custom id

Returns:

ModalMapping with this id, or null if not found

Throws:

IllegalArgumentException - If the provided id is null

See Also:

• getValues()

getValueByUniqueId

@Nullable
default ModalMapping getValueByUniqueId(int id)

Convenience method to get a ModalMapping by its numeric id from the List of ModalMappings

Returns null if no component with that id has been found

Parameters:

id - The numeric id

Returns:

ModalMapping with this numeric id, or null if not found

Throws:

IllegalArgumentException - If the provided id is null

See Also:

• getValues()

getMessage

@Nullable
Message getMessage()

Message this modal came from, if it was a reply to a ComponentInteraction.

Returns:

The message the component is attached to, or null

getChannel

@Nonnull
MessageChannelUnion getChannel()

Description copied from interface: Interaction

The channel this interaction happened in.

Specified by:

getChannel in interface Interaction

Returns:

The channel or null if the channel is not provided

getGuildChannel

@Nonnull
default GuildMessageChannelUnion getGuildChannel()

Description copied from interface: Interaction

The GuildChannel this interaction happened in.
If Interaction.getChannelType() is not a guild type, this throws IllegalStateException!

Specified by:

getGuildChannel in interface Interaction

Returns:

The GuildChannel