Package net.dv8tion.jda.api.interactions.callbacks

Interface IModalCallback

All Superinterfaces:

Interaction, ISnowflake

All Known Subinterfaces:

ButtonInteraction, CommandInteraction, ComponentInteraction, ContextInteraction<T>, EntitySelectInteraction, MessageContextInteraction, SelectMenuInteraction<T,S>, SlashCommandInteraction, StringSelectInteraction, UserContextInteraction

All Known Implementing Classes:

ButtonInteractionEvent, EntitySelectInteractionEvent, GenericCommandInteractionEvent, GenericComponentInteractionCreateEvent, GenericContextInteractionEvent, GenericSelectMenuInteractionEvent, MessageContextInteractionEvent, SlashCommandInteractionEvent, StringSelectInteractionEvent, UserContextInteractionEvent

public interface IModalCallback
extends Interaction

Interactions which allow sending modals as a response.

Sending a modal using replyModal(Modal) will automatically acknowledge this interaction.

Method Summary

Modifier and Type	Method	Description
ModalCallbackAction	replyModal(Modal modal)	Acknowledgement of this interaction with a Modal.

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

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

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

getId, getIdLong, getTimeCreated

Method Details

replyModal

@Nonnull
@CheckReturnValue
ModalCallbackAction replyModal(@Nonnull
 Modal modal)

Acknowledgement of this interaction with a Modal.

This will open a popup on the target user's Discord client.

Interactions can only be acknowledged once.

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

Parameters:

modal - The Modal to send

Returns:

ModalCallbackAction

Throws:

IllegalArgumentException - If the provided modal is null