Class ModalSubmitInteraction

applicationId

appPermissions

attachmentSizeLimit

authorizingIntegrationOwners

channelId

Readonlyclient

context

entitlements

guildId

guildLocale

id

locale

member

memberPermissions

Readonlytoken

type

user

version

createdAt

• get createdAt(): Date

  The time the interaction was created at

  Returns Date

createdTimestamp

• get createdTimestamp(): number

  The timestamp the interaction was created at

  Returns number

deferReply

• deferReply(
      options?: Omit<
          djs.InteractionDeferReplyOptions,
          "ephemeral"
          | "fetchReply"
          | "withResponse",
      >,
  ): void

  Options for deferring the reply to an BaseInteraction.

  Parameters

  • options: Omit<
        djs.InteractionDeferReplyOptions,
        "ephemeral"
        | "fetchReply"
        | "withResponse",
    > = {}

  Returns void

  Remarks

  Only MessageFlags.Ephemeral can be set.

  Example

  // Defer the reply to this interaction
  interaction.deferReply()
  Copy

  Example

  // Defer to send an ephemeral reply later
  interaction.deferReply({ flags: MessageFlags.Ephemeral })
  Copy

deferUpdate

• deferUpdate(
      options: InteractionDeferUpdateOptions & { withResponse: true },
  ): Promise<InteractionCallbackResponse>

  Parameters

  • options: InteractionDeferUpdateOptions & { withResponse: true }

  Returns Promise<InteractionCallbackResponse>

• deferUpdate(
      options: InteractionDeferUpdateOptions & { withResponse?: false },
  ): Promise<undefined>

  Parameters

  • options: InteractionDeferUpdateOptions & { withResponse?: false }

  Returns Promise<undefined>

deleteReply

• deleteReply(message?: string): Promise<void>

  Deletes a reply to this interaction.

  Parameters

  • message: string = "@original"

  Returns Promise<void>

  Example

  // Delete the initial reply to this interaction
  interaction.deleteReply()
    .then(console.log)
    .catch(console.error);
  Copy

editReply

• editReply(
      options: string | MessagePayload | InteractionEditReplyOptions,
  ): Promise<APIMessage>

  Edits a reply to this interaction.

  Parameters

  • options: string | MessagePayload | InteractionEditReplyOptions

    The new options for the message

  Returns Promise<APIMessage>

  Example

  // Edit the initial reply to this interaction
  awiat interaction.editReply('New content')
  Copy

fetchReply

• fetchReply(message?: string): Promise<APIMessage>

  Fetches a reply to this interaction.

  Parameters

  • message: string = "@original"

  Returns Promise<APIMessage>

  Example

  // Fetch the initial reply to this interaction
  const replyMessage = await interaction.fetchReply();
  console.log(replyMessage.content
  Copy

followUp

• followUp(
      options: { withResponse: true } & InteractionReplyOptions,
  ): Promise<APIMessage>

  Send a follow-up message to this interaction.

  Parameters

  • options: { withResponse: true } & InteractionReplyOptions

    The options for the reply

  Returns Promise<APIMessage>

• followUp(
      options: string | InteractionReplyOptions & { withResponse?: false },
  ): Promise<undefined>

  Send a follow-up message to this interaction.

  Parameters

  • options: string | InteractionReplyOptions & { withResponse?: false }

    The options for the reply

  Returns Promise<undefined>

inGuild

• inGuild(): boolean

  Indicates whether this interaction is received from a guild.

  Returns boolean

isAutocomplete

• isAutocomplete(): this is AutoCompleteInteraction

  Indicates whether this interaction is an AutoCompleteInteraction

  Returns this is AutoCompleteInteraction

isButton

• isButton(): this is ButtonInteraction

  Indicates whether this interaction is a ButtonInteraction.

  Returns this is ButtonInteraction

isChannelSelectMenu

• isChannelSelectMenu(): this is ChannelSelectMenuInteraction

  Indicates whether this interaction is a ChannelSelectMenuInteraction

  Returns this is ChannelSelectMenuInteraction

isChatInputCommand

• isChatInputCommand(): this is ChatInputCommandInteraction

  Indicates whether this interaction is a ChatInputCommandInteraction.

  Returns this is ChatInputCommandInteraction

isCommand

• isCommand(): this is CommandInteraction

  Indicates whether this interaction is a CommandInteraction

  Returns this is CommandInteraction

isContextMenuCommand

• isContextMenuCommand(): this is ContextMenuInteraction

  Indicates whether this interaction is a ContextMenuInteraction

  Returns this is ContextMenuInteraction

isMentionableSelectMenu

• isMentionableSelectMenu(): this is MentionableSelectMenuInteraction

  Indicates whether this interaction is a MentionableSelectMenuInteraction

  Returns this is MentionableSelectMenuInteraction

isMessageComponent

• isMessageComponent(): this is MessageComponentInteraction

  Indicates whether this interaction is a MessageComponentInteraction

  Returns this is MessageComponentInteraction

isMessageContextMenuCommand

• isMessageContextMenuCommand(): this is MessageContextMenuInteraction

  Indicates whether this interaction is a MessageContextMenuInteraction

  Returns this is MessageContextMenuInteraction

isModalSubmit

• isModalSubmit(): this is ModalSubmitInteraction

  Indicates whether this interaction is a ModalSubmitInteraction

  Returns this is ModalSubmitInteraction

isRepliable

• isRepliable(): this is | ChatInputCommandInteraction
  | ContextMenuInteraction
  | MessageComponentInteraction
  | ModalSubmitInteraction

  Indicates whether this interaction can be replied to.

  Returns this is
      | ChatInputCommandInteraction
      | ContextMenuInteraction
      | MessageComponentInteraction
      | ModalSubmitInteraction

isRoleSelectMenu

• isRoleSelectMenu(): this is RoleSelectMenuInteraction

  Indicates whether this interaction is a RoleSelectMenuInteraction

  Returns this is RoleSelectMenuInteraction

isSelectMenu

• isSelectMenu(): this is | UserSelectMenuInteraction
  | RoleSelectMenuInteraction
  | StringSelectMenuInteraction
  | ChannelSelectMenuInteraction
  | MentionableSelectMenuInteraction

  Indicates whether this interaction is a select menu of any known type.

  Returns this is
      | UserSelectMenuInteraction
      | RoleSelectMenuInteraction
      | StringSelectMenuInteraction
      | ChannelSelectMenuInteraction
      | MentionableSelectMenuInteraction

isStringSelectMenu

• isStringSelectMenu(): this is StringSelectMenuInteraction

  Indicates whether this interaction is a StringSelectMenuInteraction.

  Returns this is StringSelectMenuInteraction

isUserContextMenuCommand

• isUserContextMenuCommand(): this is UserContextMenuInteraction

  Indicates whether this interaction is a UserContextMenuInteraction

  Returns this is UserContextMenuInteraction

isUserSelectMenu

• isUserSelectMenu(): this is UserSelectMenuInteraction

  Indicates whether this interaction is a UserSelectMenuInteraction

  Returns this is UserSelectMenuInteraction

launchActivity

• launchActivity(
      options: LaunchActivityOptions & { withResponse: true },
  ): Promise<InteractionCallbackResponse>

  Parameters

  • options: LaunchActivityOptions & { withResponse: true }

  Returns Promise<InteractionCallbackResponse>

• launchActivity(
      options: LaunchActivityOptions & { withResponse?: false },
  ): Promise<undefined>

  Parameters

  • options: LaunchActivityOptions & { withResponse?: false }

  Returns Promise<undefined>

reply

• reply(
      options: string | InteractionReplyOptions & { withResponse?: false },
  ): Promise<undefined>

  Creates a reply to this interaction.

  Parameters

  • options: string | InteractionReplyOptions & { withResponse?: false }

  Returns Promise<undefined>

  Remarks

  Use the withResponse option to get the interaction callback response if a response has already been sent.

  Example

  await interaction.reply("Hello world!");
  Copy

• reply(
      options: string | InteractionReplyOptions & { withResponse: true },
  ): Promise<InteractionCallbackResponse>

  Creates a reply to this interaction.

  Parameters

  • options: string | InteractionReplyOptions & { withResponse: true }

  Returns Promise<InteractionCallbackResponse>

  Remarks

  Use the withResponse option to get the interaction callback response if a response has already been sent.

  Example

  await interaction.reply("Hello world!");
  Copy

update

• update(
      options: string | BaseMessageOptionsWithPoll & { withResponse?: false },
  ): Promise<undefined>

  Creates a reply to this interaction.

  Parameters

  • options: string | BaseMessageOptionsWithPoll & { withResponse?: false }

  Returns Promise<undefined>

  Remarks

  Use the withResponse option to get the interaction callback response if a response has already been sent.

• update(
      options: string | BaseMessageOptionsWithPoll & { withResponse: true },
  ): Promise<InteractionCallbackResponse>

  Creates a reply to this interaction.

  Parameters

  • options: string | BaseMessageOptionsWithPoll & { withResponse: true }

  Returns Promise<InteractionCallbackResponse>

  Remarks

  Use the withResponse option to get the interaction callback response if a response has already been sent.