Interface ModalInteraction
- All Superinterfaces:
IDeferrableCallback,IMessageEditCallback,Interaction,IReplyCallback,ISnowflake
- All Known Implementing Classes:
ModalInteractionEvent
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:
-
Method Summary
Modifier and TypeMethodDescriptionThe channel this interaction happened in.default GuildMessageChannelUnionTheGuildChannelthis interaction happened in.Message this modal came from, if it was a reply to aComponentInteraction.Returns the custom id of the Modal in questiondefault ModalMappingConvenience method to get aModalMappingby its id from the List ofModalMappings@Unmodifiable List<ModalMapping>Returns a List ofModalMappingsrepresenting 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
getHookMethods inherited from interface net.dv8tion.jda.api.interactions.callbacks.IMessageEditCallback
deferEdit, editComponents, editComponents, editMessage, editMessage, editMessageAttachments, editMessageAttachments, editMessageEmbeds, editMessageEmbeds, editMessageFormatMethods 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, isFromGuildMethods inherited from interface net.dv8tion.jda.api.interactions.callbacks.IReplyCallback
deferReply, deferReply, reply, reply, replyComponents, replyComponents, replyEmbeds, replyEmbeds, replyFiles, replyFiles, replyFormat, replyPollMethods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
Method Details
-
getModalId
Returns the custom id of the Modal in question- Returns:
- Custom id
- See Also:
-
getValues
Returns a List ofModalMappingsrepresenting the values input by the user for each field when the modal was submitted.- Returns:
- Immutable List of
ModalMappings - See Also:
-
getValue
Convenience method to get aModalMappingby its id from the List ofModalMappingsReturns null if no component with that id has been found
- Parameters:
id- The custom id- Returns:
- ModalMapping with this id, or null if not found
- Throws:
IllegalArgumentException- If the provided id is null- See Also:
-
getMessage
Message this modal came from, if it was a reply to aComponentInteraction.- Returns:
- The message the component is attached to, or
null
-
getChannel
Description copied from interface:InteractionThe channel this interaction happened in.- Specified by:
getChannelin interfaceInteraction- Returns:
- The channel or null if the channel is not provided
-
getGuildChannel
Description copied from interface:InteractionTheGuildChannelthis interaction happened in.
IfInteraction.getChannelType()is not a guild type, this throwsIllegalStateException!- Specified by:
getGuildChannelin interfaceInteraction- Returns:
- The
GuildChannel
-