class ModalSubmitInteraction
extends
BaseInteraction<Cached>export class ModalSubmitInteraction<Cached extends CacheType = CacheType> extends BaseInteraction<Cached>
Represents a modal interaction
Snowflake applicationId :
The application's id
optionalReadonly<PermissionsBitField> appPermissions? :
Set of permissions the application or bot has within the channel the interaction was sent from
readonlyoptionalTextBasedChannels channel? :
The channel this interaction was sent in
optionalSnowflake channelId? :
The id of the channel this interaction was sent in
readonlyClient client :
The client that instantiated this
readonlyActionRowModalData[] components :
The components within the modal
readonlyDate createdAt :
The time the interaction was created at
readonlynumber createdTimestamp :
The timestamp the interaction was created at
readonlystring customId :
The custom id of the modal.
boolean deferred :
Whether the reply to this interaction has been deferred
readonlyModalSubmitFields fields :
The fields within the modal
readonlyoptionalGuild guild? :
The guild this interaction was sent in
optionalSnowflake guildId? :
The id of the guild this interaction was sent in
optionalLocale guildLocale? :
The preferred locale from the guild this interaction was sent in
Snowflake id :
The interaction's id
Locale locale :
The locale of the user who invoked this interaction
optionalGuildMember | APIGuildMember member? :
If this interaction was sent in a guild, the member which sent it
optionalReadonly<PermissionsBitField> memberPermissions? :
The permissions of the member, if one exists, in the channel this interaction was executed in
Message<BooleanCache<Cached>> | null message :
The message associated with this interaction
boolean replied :
Whether this interaction has already been replied to
readonlystring token :
The interaction's token
InteractionType.ModalSubmit type :
The interaction's type
User user :
The user who created this interaction
number version :
The version
readonlyInteractionWebhook webhook :
An associated interaction webhook, can be used to further interact with this interaction
deferReplyoptions: InteractionDeferReplyOptions & { fetchReply: true }) : Promise<Message<BooleanCache<Cached>>> (
Defers the reply to this interaction.
// Defer the reply to this interaction
interaction.deferReply()
.then(console.log)
.catch(console.error)
// Defer to send an ephemeral reply later
interaction.deferReply({ ephemeral: true })
.then(console.log)
.catch(console.error);
deferUpdateoptions: InteractionDeferUpdateOptions & { fetchReply: true }) : Promise<Message<BooleanCache<Cached>>> (
Defers an update to the message to which the component was attached.
// Defer updating and reset the component's loading state
interaction.deferUpdate()
.then(console.log)
.catch(console.error);
deleteReplymessage?: MessageResolvable | '@original') : Promise<void> (
Deletes a reply to this interaction.
// Delete the initial reply to this interaction
interaction.deleteReply()
.then(console.log)
.catch(console.error);
editReplyoptions: string | MessagePayload | InteractionEditReplyOptions) : Promise<Message<BooleanCache<Cached>>> (
Edits a reply to this interaction.
// Edit the initial reply to this interaction
interaction.editReply('New content')
.then(console.log)
.catch(console.error);
fetchReplymessage?: Snowflake | '@original') : Promise<Message<BooleanCache<Cached>>> (
Fetches a reply to this interaction.
// Fetch the initial reply to this interaction
interaction.fetchReply()
.then(reply => console.log(`Replied with ${reply.content}`))
.catch(console.error);
followUpoptions: string | MessagePayload | InteractionReplyOptions) : Promise<Message<BooleanCache<Cached>>> (
Send a follow-up message to this interaction.
inCachedGuildthis is ModalSubmitInteraction<'cached'> () :
Indicates whether or not this interaction is both cached and received from a guild.
inGuildthis is ModalSubmitInteraction<'raw' | 'cached'> () :
Indicates whether this interaction is received from a guild.
inRawGuildthis is ModalSubmitInteraction<'raw'> () :
Indicates whether or not this interaction is received from an uncached guild.
isAnySelectMenuthis is AnySelectMenuInteraction<Cached> () :
Indicates whether this interaction is a select menu of any known type.
Inherited from: BaseInteraction
isAutocompletethis is AutocompleteInteraction<Cached> () :
Indicates whether this interaction is an AutocompleteInteraction
Inherited from: BaseInteraction
isButtonthis is ButtonInteraction<Cached> () :
Indicates whether this interaction is a ButtonInteraction.
Inherited from: BaseInteraction
isChannelSelectMenuthis is ChannelSelectMenuInteraction<Cached> () :
Indicates whether this interaction is a ChannelSelectMenuInteraction
Inherited from: BaseInteraction
isChatInputCommandthis is ChatInputCommandInteraction<Cached> () :
Indicates whether this interaction is a ChatInputCommandInteraction.
Inherited from: BaseInteraction
isCommandthis is CommandInteraction<Cached> () :
Indicates whether this interaction is a CommandInteraction
Inherited from: BaseInteraction
isContextMenuCommandthis is ContextMenuCommandInteraction<Cached> () :
Indicates whether this interaction is a ContextMenuCommandInteraction
Inherited from: BaseInteraction
isFromMessagethis is ModalMessageModalSubmitInteraction<Cached> () :
Whether this is from a MessageComponentInteraction.
isMentionableSelectMenuthis is MentionableSelectMenuInteraction<Cached> () :
Indicates whether this interaction is a MentionableSelectMenuInteraction
Inherited from: BaseInteraction
isMessageComponentthis is MessageComponentInteraction<Cached> () :
Indicates whether this interaction is a MessageComponentInteraction
Inherited from: BaseInteraction
isMessageContextMenuCommandthis is MessageContextMenuCommandInteraction<Cached> () :
Indicates whether this interaction is a MessageContextMenuCommandInteraction
Inherited from: BaseInteraction
isModalSubmitthis is ModalSubmitInteraction<Cached> () :
Indicates whether this interaction is a ModalSubmitInteraction
Inherited from: BaseInteraction
isRepliablethis is RepliableInteraction<Cached> () :
Indicates whether this interaction can be replied to.
Inherited from: BaseInteraction
isRoleSelectMenuthis is RoleSelectMenuInteraction<Cached> () :
Indicates whether this interaction is a RoleSelectMenuInteraction
Inherited from: BaseInteraction
deprecated isSelectMenuthis is StringSelectMenuInteraction<Cached> () :
Use isStringSelectMenu instead.
Indicates whether this interaction is a StringSelectMenuInteraction.
Inherited from: BaseInteraction
isStringSelectMenuthis is StringSelectMenuInteraction<Cached> () :
Indicates whether this interaction is a StringSelectMenuInteraction.
Inherited from: BaseInteraction
isUserContextMenuCommandthis is UserContextMenuCommandInteraction<Cached> () :
Indicates whether this interaction is a UserContextMenuCommandInteraction
Inherited from: BaseInteraction
isUserSelectMenuthis is UserSelectMenuInteraction<Cached> () :
Indicates whether this interaction is a UserSelectMenuInteraction
Inherited from: BaseInteraction
replyoptions: InteractionReplyOptions & { fetchReply: true }) : Promise<Message<BooleanCache<Cached>>> (
Creates a reply to this interaction. Use the fetchReply
option to get the bot's reply message.
// Reply to the interaction and fetch the response
interaction.reply({ content: 'Pong!', fetchReply: true })
.then((message) => console.log(`Reply sent with content ${message.content}`))
.catch(console.error);
// Create an ephemeral reply with an embed
const embed = new EmbedBuilder().setDescription('Pong!');
interaction.reply({ embeds: [embed], ephemeral: true })
.then(() => console.log('Reply sent.'))
.catch(console.error);
Transforms component data to discord.js-compatible data
updateoptions: string | MessagePayload | InteractionUpdateOptions) : Promise<(Message|void)> (
Updates the original message of the component on which the interaction was received on.
// Remove the components from the message
interaction.update({
content: "A component interaction was received",
components: []
})
.then(console.log)
.catch(console.error);