Package net.dv8tion.jda.api.events.interaction

Class ModalInteractionEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent

net.dv8tion.jda.api.events.interaction.ModalInteractionEvent

All Implemented Interfaces:

ISnowflake, GenericEvent, IDeferrableCallback, IMessageEditCallback, IReplyCallback, Interaction, ModalInteraction

public class ModalInteractionEvent
extends GenericInteractionCreateEvent
implements ModalInteraction

Indicates that a Modal was submitted.

Requirements
To receive these events, you must unset the Interactions Endpoint URL in your application dashboard. You can simply remove the URL for this endpoint in your settings at the Discord Developers Portal.

See Also:

• ModalInteraction

Constructor Summary

Constructors

Constructor	Description
ModalInteractionEvent(JDA api, long responseNumber, ModalInteraction interaction)

Method Summary

Modifier and Type	Method	Description
MessageEditCallbackAction	deferEdit()	No-op acknowledgement of this interaction.
ReplyCallbackAction	deferReply()	Acknowledge this interaction and defer the reply to a later time.
MessageChannelUnion	getChannel()	The channel this interaction happened in.
InteractionHook	getHook()	The InteractionHook which can be used to send deferred replies or followup messages.
ModalInteraction	getInteraction()	The Interaction instance.
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
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 class net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent

getChannelIdLong, getEntitlements, getGuild, getGuildLocale, getIdLong, getMember, getToken, getTypeRaw, getUser, getUserLocale, isAcknowledged

Methods inherited from class net.dv8tion.jda.api.events.Event

getJDA, getRawData, getResponseNumber, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

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

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

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

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

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

getId, getIdLong, getTimeCreated

Methods inherited from interface net.dv8tion.jda.api.interactions.modals.ModalInteraction

getGuildChannel, getValue

Constructor Details

ModalInteractionEvent

public ModalInteractionEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 ModalInteraction interaction)

Method Details

getInteraction

@Nonnull
public ModalInteraction getInteraction()

Description copied from class: GenericInteractionCreateEvent

The Interaction instance.
Note that this event is a delegate which implements the same interface.

Overrides:

getInteraction in class GenericInteractionCreateEvent

Returns:

The Interaction

getModalId

@Nonnull
public String getModalId()

Description copied from interface: ModalInteraction

Returns the custom id of the Modal in question

Specified by:

getModalId in interface ModalInteraction

Returns:

Custom id

See Also:

• Modal.Builder.setId(String)

getValues

@Nonnull
public List<ModalMapping> getValues()

Description copied from interface: ModalInteraction

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

Specified by:

getValues in interface ModalInteraction

Returns:

Immutable List of ModalMappings

See Also:

• ModalInteraction.getValue(String)

getMessage

@Nullable
public Message getMessage()

Description copied from interface: ModalInteraction

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

Specified by:

getMessage in interface ModalInteraction

Returns:

The message the component is attached to, or null

deferReply

@Nonnull
@CheckReturnValue
public ReplyCallbackAction deferReply()

Description copied from interface: IReplyCallback

Acknowledge this interaction and defer the reply to a later time.
This will send a <Bot> is thinking... message in chat that will be updated later through either InteractionHook.editOriginal(String) or WebhookClient.sendMessage(String).

You can use deferReply(true) to send a deferred ephemeral reply. If your initial deferred message is not ephemeral it cannot be made ephemeral later. Your first message to the InteractionHook will inherit whether the message is ephemeral or not from this deferred reply.

You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receive ErrorResponse.UNKNOWN_INTERACTION.

Use IReplyCallback.reply(String) to reply directly.

Specified by:

deferReply in interface IReplyCallback

Returns:

ReplyCallbackAction

getHook

@Nonnull
public InteractionHook getHook()

Description copied from interface: IDeferrableCallback

The InteractionHook which can be used to send deferred replies or followup messages.

Specified by:

getHook in interface IDeferrableCallback

Returns:

The interaction hook

deferEdit

@Nonnull
@CheckReturnValue
public MessageEditCallbackAction deferEdit()

Description copied from interface: IMessageEditCallback

No-op acknowledgement of this interaction.
This tells discord you intend to update the message that the triggering component is a part of using the InteractionHook instead of sending a reply message. You are not required to actually update the message, this will simply acknowledge that you accepted the interaction.

You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receive ErrorResponse.UNKNOWN_INTERACTION.

Use IMessageEditCallback.editMessage(String) to edit it directly.

Specified by:

deferEdit in interface IMessageEditCallback

Returns:

MessageEditCallbackAction that can be used to update the message

See Also:

• IMessageEditCallback.editMessage(String)

getChannel

@Nonnull
public MessageChannelUnion getChannel()

Description copied from interface: Interaction

The channel this interaction happened in.

Specified by:

getChannel in interface Interaction

Specified by:

getChannel in interface ModalInteraction

Overrides:

getChannel in class GenericInteractionCreateEvent

Returns:

The channel or null if the channel is not provided