Class MessageComponentInteraction<Cached>

channelId

componentType

customId

deferred

ephemeral

message

replied

type

webhook

component

• get component(): CacheTypeReducer<
      Cached,
      MessageActionRowComponent,
      APIComponentInMessageActionRow,
      APIComponentInMessageActionRow
      | MessageActionRowComponent,
      APIComponentInMessageActionRow | MessageActionRowComponent,
  >

  Returns CacheTypeReducer<
      Cached,
      MessageActionRowComponent,
      APIComponentInMessageActionRow,
      APIComponentInMessageActionRow
      | MessageActionRowComponent,
      APIComponentInMessageActionRow | MessageActionRowComponent,
  >

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

inCachedGuild

• inCachedGuild(): this is MessageComponentInteraction<"cached">

  Returns this is MessageComponentInteraction<"cached">

inGuild

• inGuild(): this is MessageComponentInteraction<"raw" | "cached">

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

inRawGuild

• inRawGuild(): this is MessageComponentInteraction<"raw">

  Returns this is MessageComponentInteraction<"raw">

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>

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