Class ButtonInteraction<Cached>

applicationId

appPermissions

attachmentSizeLimit

authorizingIntegrationOwners

channelId

Readonlyclient

context

customId

deferred

entitlements

ephemeral

guildId

guildLocale

id

locale

member

memberPermissions

message

replied

Readonlytoken

type

user

version

webhook

channel

• get channel(): CacheTypeReducer<
      Cached,
      null
      | GuildTextBasedChannel,
      null | GuildTextBasedChannel,
      null | GuildTextBasedChannel,
      null | TextBasedChannel,
  >

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

createdAt

• get createdAt(): Date

  Returns Date

createdTimestamp

• get createdTimestamp(): number

  Returns number

guild

• get guild(): CacheTypeReducer<Cached, Guild, null>

  Returns CacheTypeReducer<Cached, Guild, null>

awaitModalSubmit

• awaitModalSubmit(
      options: AwaitModalSubmitOptions<ModalSubmitInteraction<CacheType>>,
  ): Promise<ModalSubmitInteraction<Cached>>

  Parameters

  • options: AwaitModalSubmitOptions<ModalSubmitInteraction<CacheType>>

  Returns Promise<ModalSubmitInteraction<Cached>>

deferReply

• deferReply(
      options: InteractionDeferReplyOptions & { withResponse: true },
  ): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>

  Parameters

  • options: InteractionDeferReplyOptions & { withResponse: true }

  Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>

• 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.

• deferReply(
      options?: InteractionDeferReplyOptions,
  ): Promise<InteractionResponse<BooleanCache<Cached>>>

  Parameters

  • Optionaloptions: InteractionDeferReplyOptions

  Returns Promise<InteractionResponse<BooleanCache<Cached>>>

deferUpdate

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

  Parameters

  • options: InteractionDeferUpdateOptions & { withResponse: true }

  Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>

• 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.

• deferUpdate(
      options?: InteractionDeferUpdateOptions,
  ): Promise<InteractionResponse<BooleanCache<Cached>>>

  Parameters

  • Optionaloptions: InteractionDeferUpdateOptions

  Returns Promise<InteractionResponse<BooleanCache<Cached>>>

deleteReply

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

  Parameters

  • Optionalmessage: MessageResolvable

  Returns Promise<void>

editReply

• editReply(
      options: string | MessagePayload | InteractionEditReplyOptions,
  ): Promise<Message<BooleanCache<Cached>>>

  Parameters

  • options: string | MessagePayload | InteractionEditReplyOptions

  Returns Promise<Message<BooleanCache<Cached>>>

fetchReply

• fetchReply(message?: string): Promise<Message<BooleanCache<Cached>>>

  Parameters

  • Optionalmessage: string

  Returns Promise<Message<BooleanCache<Cached>>>

followUp

• followUp(
      options: string | MessagePayload | InteractionReplyOptions,
  ): Promise<Message<BooleanCache<Cached>>>

  Parameters

  • options: string | MessagePayload | InteractionReplyOptions

  Returns Promise<Message<BooleanCache<Cached>>>

isAnySelectMenu

• isAnySelectMenu(): this is AnySelectMenuInteraction<Cached>

  Returns this is AnySelectMenuInteraction<Cached>

isAutocomplete

• isAutocomplete(): this is AutocompleteInteraction<Cached>

  Returns this is AutocompleteInteraction<Cached>

isButton

• isButton(): this is ButtonInteraction<Cached>

  Returns this is ButtonInteraction<Cached>

isChannelSelectMenu

• isChannelSelectMenu(): this is ChannelSelectMenuInteraction<Cached>

  Returns this is ChannelSelectMenuInteraction<Cached>

isChatInputCommand

• isChatInputCommand(): this is ChatInputCommandInteraction<Cached>

  Returns this is ChatInputCommandInteraction<Cached>

isCommand

• isCommand(): this is CommandInteraction<Cached>

  Returns this is CommandInteraction<Cached>

isContextMenuCommand

• isContextMenuCommand(): this is ContextMenuCommandInteraction<Cached>

  Returns this is ContextMenuCommandInteraction<Cached>

isMentionableSelectMenu

• isMentionableSelectMenu(): this is MentionableSelectMenuInteraction<Cached>

  Returns this is MentionableSelectMenuInteraction<Cached>

isMessageComponent

• isMessageComponent(): this is MessageComponentInteraction<Cached>

  Returns this is MessageComponentInteraction<Cached>

isMessageContextMenuCommand

• isMessageContextMenuCommand(): this is MessageContextMenuCommandInteraction<
      Cached,
  >

  Returns this is MessageContextMenuCommandInteraction<Cached>

isModalSubmit

• isModalSubmit(): this is ModalSubmitInteraction<Cached>

  Returns this is ModalSubmitInteraction<Cached>

isPrimaryEntryPointCommand

• isPrimaryEntryPointCommand(): this is PrimaryEntryPointCommandInteraction<
      Cached,
  >

  Returns this is PrimaryEntryPointCommandInteraction<Cached>

isRepliable

• isRepliable(): this is RepliableInteraction<Cached>

  Returns this is RepliableInteraction<Cached>

isRoleSelectMenu

• isRoleSelectMenu(): this is RoleSelectMenuInteraction<Cached>

  Returns this is RoleSelectMenuInteraction<Cached>

isSelectMenu

• isSelectMenu(): this is StringSelectMenuInteraction<Cached>

  Returns this is StringSelectMenuInteraction<Cached>

  Deprecated

  Use BaseInteraction.isStringSelectMenu instead.

isStringSelectMenu

• isStringSelectMenu(): this is StringSelectMenuInteraction<Cached>

  Returns this is StringSelectMenuInteraction<Cached>

isUserContextMenuCommand

• isUserContextMenuCommand(): this is UserContextMenuCommandInteraction<Cached>

  Returns this is UserContextMenuCommandInteraction<Cached>

isUserSelectMenu

• isUserSelectMenu(): this is UserSelectMenuInteraction<Cached>

  Returns this is UserSelectMenuInteraction<Cached>

launchActivity

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

  Parameters

  • options: LaunchActivityOptions & { withResponse: true }

  Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>

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

  Parameters

  • Optionaloptions: LaunchActivityOptions & { withResponse?: false }

  Returns Promise<undefined>

• launchActivity(
      options?: LaunchActivityOptions,
  ): Promise<undefined | InteractionCallbackResponse<BooleanCache<Cached>>>

  Parameters

  • Optionaloptions: LaunchActivityOptions

  Returns Promise<undefined | InteractionCallbackResponse<BooleanCache<Cached>>>

reply

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

  Parameters

  • options: InteractionReplyOptions & { withResponse: true }

  Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>

• 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.

• reply(
      options: string | MessagePayload | InteractionReplyOptions,
  ): Promise<InteractionResponse<BooleanCache<Cached>>>

  Parameters

  • options: string | MessagePayload | InteractionReplyOptions

  Returns Promise<InteractionResponse<BooleanCache<Cached>>>

sendPremiumRequired

• sendPremiumRequired(): Promise<void>

  Returns Promise<void>

  Deprecated

  Sending a premium-style button is the new Discord behaviour.

showModal

• showModal(
      modal:
          | APIModalInteractionResponseCallbackData
          | JSONEncodable<APIModalInteractionResponseCallbackData>
          | ModalComponentData,
      options: ShowModalOptions & { withResponse: true },
  ): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>

  Parameters

  • modal:
        | APIModalInteractionResponseCallbackData
        | JSONEncodable<APIModalInteractionResponseCallbackData>
        | ModalComponentData
  • options: ShowModalOptions & { withResponse: true }

  Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>

• showModal(
      modal:
          | APIModalInteractionResponseCallbackData
          | JSONEncodable<APIModalInteractionResponseCallbackData>
          | ModalComponentData,
      options?: ShowModalOptions,
  ): Promise<undefined>

  Parameters

  • modal:
        | APIModalInteractionResponseCallbackData
        | JSONEncodable<APIModalInteractionResponseCallbackData>
        | ModalComponentData
  • Optionaloptions: ShowModalOptions

  Returns Promise<undefined>

• showModal(
      modal:
          | APIModalInteractionResponseCallbackData
          | JSONEncodable<APIModalInteractionResponseCallbackData>
          | ModalComponentData,
      options?: ShowModalOptions,
  ): Promise<undefined>

  Parameters

  • modal:
        | APIModalInteractionResponseCallbackData
        | JSONEncodable<APIModalInteractionResponseCallbackData>
        | ModalComponentData
  • Optionaloptions: ShowModalOptions

  Returns Promise<undefined>

toJSON

• toJSON(...props: Record<string, string | boolean>[]): unknown

  Parameters

  • ...props: Record<string, string | boolean>[]

  Returns unknown

update

• update(
      options: InteractionUpdateOptions & { withResponse: true },
  ): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>

  Parameters

  • options: InteractionUpdateOptions & { withResponse: true }

  Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>

• update(
      options: InteractionUpdateOptions & { fetchReply: true },
  ): Promise<Message<BooleanCache<Cached>>>

  Parameters

  • options: InteractionUpdateOptions & { fetchReply: true }

  Returns Promise<Message<BooleanCache<Cached>>>

  Deprecated

  fetchReply is deprecated. Use withResponse instead or fetch the response after using the method.

• update(
      options: string | MessagePayload | InteractionUpdateOptions,
  ): Promise<InteractionResponse<BooleanCache<Cached>>>

  Parameters

  • options: string | MessagePayload | InteractionUpdateOptions

  Returns Promise<InteractionResponse<BooleanCache<Cached>>>

valueOf

• valueOf(): string

  Returns string