Class ModalSubmitInteraction<Cached>

Type Parameters

Cached extends CacheType = CacheType

Hierarchy (View Summary)

BaseInteraction<Cached>
- ModalSubmitInteraction
  - ModalMessageModalSubmitInteraction

Properties

applicationId

applicationId: string

appPermissions

appPermissions: Readonly<PermissionsBitField>

attachmentSizeLimit

attachmentSizeLimit: number

authorizingIntegrationOwners

authorizingIntegrationOwners: APIAuthorizingIntegrationOwnersMap

channelId

channelId: null | string

`Readonly`client

client: Client<true>

`Readonly`components

components: ActionRowModalData[]

context

context: null | InteractionContextType

`Readonly`customId

customId: string

deferred

deferred: boolean

entitlements

entitlements: Collection<string, Entitlement>

ephemeral

ephemeral: null | boolean

id

id: string

locale

locale: Locale

member

member: CacheTypeReducer<Cached, GuildMember, APIInteractionGuildMember>

memberPermissions

memberPermissions: CacheTypeReducer<Cached, Readonly<PermissionsBitField>>

message

message: null | Message<BooleanCache<Cached>>

replied

replied: boolean

`Readonly`token

token: string

type

type: ModalSubmit

user

user: User

version

version: number

`Readonly`webhook

webhook: InteractionWebhook

Accessors

channel

get channel(): CacheTypeReducer<
    Cached,
    null
    | GuildTextBasedChannel,
    null | GuildTextBasedChannel,
    null | GuildTextBasedChannel,
    null | TextBasedChannel,
>
Returns CacheTypeReducer<
    Cached,
    null
    | GuildTextBasedChannel,
    null | GuildTextBasedChannel,
    null | GuildTextBasedChannel,
    null | TextBasedChannel,
>
Inherited from BaseInteraction.channel
- Defined in node_modules/discord.js/typings/index.d.ts:2115

createdAt

get createdAt(): Date
Returns Date
Inherited from BaseInteraction.createdAt
- Defined in node_modules/discord.js/typings/index.d.ts:2124

createdTimestamp

get createdTimestamp(): number
Returns number
Inherited from BaseInteraction.createdTimestamp
- Defined in node_modules/discord.js/typings/index.d.ts:2125

guild

get guild(): CacheTypeReducer<Cached, Guild, null>
Returns CacheTypeReducer<Cached, Guild, null>
Inherited from BaseInteraction.guild
- Defined in node_modules/discord.js/typings/index.d.ts:2126

Methods

deferReply

deferReply(
options: InteractionDeferReplyOptions & { withResponse: true },
): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
Parameters
- options: InteractionDeferReplyOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2817
deferReply(
options: InteractionDeferReplyOptions & { fetchReply: true },
): Promise<Message<BooleanCache<Cached>>>
Parameters
- options: InteractionDeferReplyOptions & { fetchReply: true }
Returns Promise<Message<BooleanCache<Cached>>>
Deprecated
fetchReply is deprecated. Use withResponse instead or fetch the response after using the method.
- Defined in node_modules/discord.js/typings/index.d.ts:2821
deferReply(
options?: InteractionDeferReplyOptions,
): Promise<InteractionResponse<BooleanCache<Cached>>>
Parameters
- Optionaloptions: InteractionDeferReplyOptions
Returns Promise<InteractionResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2824

deferUpdate

deferUpdate(
options: InteractionDeferUpdateOptions & { withResponse: true },
): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
Parameters
- options: InteractionDeferUpdateOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2827
deferUpdate(
options: InteractionDeferUpdateOptions & { fetchReply: true },
): Promise<Message<BooleanCache<Cached>>>
Parameters
- options: InteractionDeferUpdateOptions & { fetchReply: true }
Returns Promise<Message<BooleanCache<Cached>>>
Deprecated
fetchReply is deprecated. Use withResponse instead or fetch the response after using the method.
- Defined in node_modules/discord.js/typings/index.d.ts:2831
deferUpdate(
options?: InteractionDeferUpdateOptions,
): Promise<InteractionResponse<BooleanCache<Cached>>>
Parameters
- Optionaloptions: InteractionDeferUpdateOptions
Returns Promise<InteractionResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2834

deleteReply

deleteReply(message?: MessageResolvable): Promise<void>
Parameters
- Optionalmessage: MessageResolvable
Returns Promise<void>
- Defined in node_modules/discord.js/typings/index.d.ts:2813

editReply

editReply(
options: string | MessagePayload | InteractionEditReplyOptions,
): Promise<Message<BooleanCache<Cached>>>
Parameters
- options: string | MessagePayload | InteractionEditReplyOptions
Returns Promise<Message<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2814

fetchReply

fetchReply(message?: string): Promise<Message<BooleanCache<Cached>>>
Parameters
- Optionalmessage: string
Returns Promise<Message<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2825

followUp

followUp(
options: string | MessagePayload | InteractionReplyOptions,
): Promise<Message<BooleanCache<Cached>>>
Parameters
- options: string | MessagePayload | InteractionReplyOptions
Returns Promise<Message<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2826

inCachedGuild

inCachedGuild(): this is ModalSubmitInteraction<"cached">
Returns this is ModalSubmitInteraction<"cached">
Overrides BaseInteraction.inCachedGuild
- Defined in node_modules/discord.js/typings/index.d.ts:2845

inGuild

inGuild(): this is ModalSubmitInteraction<"raw" | "cached">
Returns this is ModalSubmitInteraction<"raw" | "cached">
Overrides BaseInteraction.inGuild
- Defined in node_modules/discord.js/typings/index.d.ts:2844

inRawGuild

inRawGuild(): this is ModalSubmitInteraction<"raw">
Returns this is ModalSubmitInteraction<"raw">
Overrides BaseInteraction.inRawGuild
- Defined in node_modules/discord.js/typings/index.d.ts:2846

isAnySelectMenu

isAnySelectMenu(): this is AnySelectMenuInteraction<Cached>
Returns this is AnySelectMenuInteraction<Cached>
Inherited from BaseInteraction.isAnySelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2155

isAutocomplete

isAutocomplete(): this is AutocompleteInteraction<Cached>
Returns this is AutocompleteInteraction<Cached>
Inherited from BaseInteraction.isAutocomplete
- Defined in node_modules/discord.js/typings/index.d.ts:2144

isButton

isButton(): this is ButtonInteraction<Cached>
Returns this is ButtonInteraction<Cached>
Inherited from BaseInteraction.isButton
- Defined in node_modules/discord.js/typings/index.d.ts:2143

isChannelSelectMenu

isChannelSelectMenu(): this is ChannelSelectMenuInteraction<Cached>
Returns this is ChannelSelectMenuInteraction<Cached>
Inherited from BaseInteraction.isChannelSelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2160

isChatInputCommand

isChatInputCommand(): this is ChatInputCommandInteraction<Cached>
Returns this is ChatInputCommandInteraction<Cached>
Inherited from BaseInteraction.isChatInputCommand
- Defined in node_modules/discord.js/typings/index.d.ts:2145

isCommand

isCommand(): this is CommandInteraction<Cached>
Returns this is CommandInteraction<Cached>
Inherited from BaseInteraction.isCommand
- Defined in node_modules/discord.js/typings/index.d.ts:2146

isContextMenuCommand

isContextMenuCommand(): this is ContextMenuCommandInteraction<Cached>
Returns this is ContextMenuCommandInteraction<Cached>
Inherited from BaseInteraction.isContextMenuCommand
- Defined in node_modules/discord.js/typings/index.d.ts:2147

isFromMessage

isFromMessage(): this is ModalMessageModalSubmitInteraction<Cached>
Returns this is ModalMessageModalSubmitInteraction<Cached>
- Defined in node_modules/discord.js/typings/index.d.ts:2847

isMentionableSelectMenu

isMentionableSelectMenu(): this is MentionableSelectMenuInteraction<Cached>
Returns this is MentionableSelectMenuInteraction<Cached>
Inherited from BaseInteraction.isMentionableSelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2159

isMessageComponent

isMessageComponent(): this is MessageComponentInteraction<Cached>
Returns this is MessageComponentInteraction<Cached>
Inherited from BaseInteraction.isMessageComponent
- Defined in node_modules/discord.js/typings/index.d.ts:2149

isMessageContextMenuCommand

isMessageContextMenuCommand(): this is MessageContextMenuCommandInteraction<
Cached,
>
Returns this is MessageContextMenuCommandInteraction<Cached>
Inherited from BaseInteraction.isMessageContextMenuCommand
- Defined in node_modules/discord.js/typings/index.d.ts:2150

isModalSubmit

isModalSubmit(): this is ModalSubmitInteraction<Cached>
Returns this is ModalSubmitInteraction<Cached>
Inherited from BaseInteraction.isModalSubmit
- Defined in node_modules/discord.js/typings/index.d.ts:2151

isPrimaryEntryPointCommand

isPrimaryEntryPointCommand(): this is PrimaryEntryPointCommandInteraction<
Cached,
>
Returns this is PrimaryEntryPointCommandInteraction<Cached>
Inherited from BaseInteraction.isPrimaryEntryPointCommand
- Defined in node_modules/discord.js/typings/index.d.ts:2148

isRepliable

isRepliable(): this is RepliableInteraction<Cached>
Returns this is RepliableInteraction<Cached>
Inherited from BaseInteraction.isRepliable
- Defined in node_modules/discord.js/typings/index.d.ts:2161

isRoleSelectMenu

isRoleSelectMenu(): this is RoleSelectMenuInteraction<Cached>
Returns this is RoleSelectMenuInteraction<Cached>
Inherited from BaseInteraction.isRoleSelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2158

isSelectMenu

isSelectMenu(): this is StringSelectMenuInteraction<Cached>
Returns this is StringSelectMenuInteraction<Cached>
Deprecated
Use BaseInteraction.isStringSelectMenu instead.
Inherited from BaseInteraction.isSelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2154

isStringSelectMenu

isStringSelectMenu(): this is StringSelectMenuInteraction<Cached>
Returns this is StringSelectMenuInteraction<Cached>
Inherited from BaseInteraction.isStringSelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2156

isUserContextMenuCommand

isUserContextMenuCommand(): this is UserContextMenuCommandInteraction<Cached>
Returns this is UserContextMenuCommandInteraction<Cached>
Inherited from BaseInteraction.isUserContextMenuCommand
- Defined in node_modules/discord.js/typings/index.d.ts:2152

isUserSelectMenu

isUserSelectMenu(): this is UserSelectMenuInteraction<Cached>
Returns this is UserSelectMenuInteraction<Cached>
Inherited from BaseInteraction.isUserSelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2157

launchActivity

launchActivity(
options: LaunchActivityOptions & { withResponse: true },
): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
Parameters
- options: LaunchActivityOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2837
launchActivity(
options?: LaunchActivityOptions & { withResponse?: false },
): Promise<undefined>
Parameters
- Optionaloptions: LaunchActivityOptions & { withResponse?: false }
Returns Promise<undefined>
- Defined in node_modules/discord.js/typings/index.d.ts:2840
launchActivity(
options?: LaunchActivityOptions,
): Promise<undefined | InteractionCallbackResponse<BooleanCache<Cached>>>
Parameters
- Optionaloptions: LaunchActivityOptions
Returns Promise<undefined | InteractionCallbackResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2841

reply

reply(
options: InteractionReplyOptions & { withResponse: true },
): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
Parameters
- options: InteractionReplyOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2805
reply(
options: InteractionReplyOptions & { fetchReply: true },
): Promise<Message<BooleanCache<Cached>>>
Parameters
- options: InteractionReplyOptions & { fetchReply: true }
Returns Promise<Message<BooleanCache<Cached>>>
Deprecated
fetchReply is deprecated. Use withResponse instead or fetch the response after using the method.
- Defined in node_modules/discord.js/typings/index.d.ts:2809
reply(
options: string | MessagePayload | InteractionReplyOptions,
): Promise<InteractionResponse<BooleanCache<Cached>>>
Parameters
- options: string | MessagePayload | InteractionReplyOptions
Returns Promise<InteractionResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2810

sendPremiumRequired

sendPremiumRequired(): Promise<void>
Returns Promise<void>
Deprecated
Sending a premium-style button is the new Discord behaviour.
- Defined in node_modules/discord.js/typings/index.d.ts:2836

toJSON

toJSON(...props: Record<string, string | boolean>[]): unknown
Parameters
- ...props: Record<string, string | boolean>[]
Returns unknown
Inherited from BaseInteraction.toJSON
- Defined in node_modules/discord.js/typings/index.d.ts:560

valueOf

valueOf(): string
Returns string
Inherited from BaseInteraction.valueOf
- Defined in node_modules/discord.js/typings/index.d.ts:561

Class ModalSubmitInteraction<Cached>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

applicationId

appPermissions

attachmentSizeLimit

authorizingIntegrationOwners

channelId

Readonlyclient

Readonlycomponents

context

ReadonlycustomId

deferred

entitlements

ephemeral

Readonlyfields

guildId

guildLocale

id

locale

member

memberPermissions

message

replied

Readonlytoken

type

user

version

Readonlywebhook

Accessors

channel

Returns CacheTypeReducer< Cached, null | GuildTextBasedChannel, null | GuildTextBasedChannel, null | GuildTextBasedChannel, null | TextBasedChannel,>

createdAt

Returns Date

createdTimestamp

Returns number

guild

Returns CacheTypeReducer<Cached, Guild, null>

Methods

deferReply

Parameters

Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>

Parameters

Returns Promise<Message<BooleanCache<Cached>>>

Deprecated

Parameters

Returns Promise<InteractionResponse<BooleanCache<Cached>>>

deferUpdate

Parameters

Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>

Parameters

Returns Promise<Message<BooleanCache<Cached>>>

Deprecated

Parameters

Returns Promise<InteractionResponse<BooleanCache<Cached>>>

deleteReply

Parameters

Returns Promise<void>

editReply

Parameters

Returns Promise<Message<BooleanCache<Cached>>>

fetchReply

Parameters

Returns Promise<Message<BooleanCache<Cached>>>

followUp

Parameters

Returns Promise<Message<BooleanCache<Cached>>>

inCachedGuild

Returns this is ModalSubmitInteraction<"cached">

inGuild

Returns this is ModalSubmitInteraction<"raw" | "cached">

inRawGuild

Returns this is ModalSubmitInteraction<"raw">

isAnySelectMenu

Returns this is AnySelectMenuInteraction<Cached>

`Readonly`client

`Readonly`components

`Readonly`customId

`Readonly`fields

`Readonly`token

`Readonly`webhook

Returns CacheTypeReducer<
Cached,
null
| GuildTextBasedChannel,
null | GuildTextBasedChannel,
null | GuildTextBasedChannel,
null | TextBasedChannel,
>