Class ComponentInteraction<FromGuild, Type>

constructor

• new ComponentInteraction<
      FromGuild extends boolean = boolean,
      Type extends
          APIMessageComponentInteraction = APIMessageComponentInteraction,
  >(
      client: UsingClient,
      interaction: Type,
      __reply?: __InternalReplyFunction,
  ): ComponentInteraction<FromGuild, Type>

  Type Parameters

  • FromGuild extends boolean = boolean
  • Type extends APIMessageComponentInteraction = APIMessageComponentInteraction

  Parameters

  • client: UsingClient
  • interaction: Type
  • Optional__reply: __InternalReplyFunction

  Returns ComponentInteraction<FromGuild, Type>

appPermissions

channel

Readonlyclient

data

member

message

Optionalreplied

type

user

componentType

• get componentType(): | Button
  | StringSelect
  | UserSelect
  | RoleSelect
  | MentionableSelect
  | ChannelSelect

  Returns
      | Button
      | StringSelect
      | UserSelect
      | RoleSelect
      | MentionableSelect
      | ChannelSelect

createdAt

• get createdAt(): Date

  createdAt gets the creation Date instace of the current object.

  Returns Date

createdTimestamp

• get createdTimestamp(): number

  Create a timestamp for the current object.

  Returns number

customId

• get customId(): string

  Returns string

deferReply

• deferReply<WR extends boolean = false>(
      flags?: MessageFlags,
      withResponse?: WR,
  ): Promise<When<WR, WebhookMessage, undefined>>

  Type Parameters

  • WR extends boolean = false

  Parameters

  • Optionalflags: MessageFlags
  • OptionalwithResponse: WR

  Returns Promise<When<WR, WebhookMessage, undefined>>

deferUpdate

• deferUpdate(): Promise<undefined>

  Returns Promise<undefined>

deleteMessage

• deleteMessage(messageId: string): Promise<void>

  Parameters

  • messageId: string

  Returns Promise<void>

deleteResponse

• deleteResponse(): Promise<void>

  Returns Promise<void>

editMessage

• editMessage(
      messageId: string,
      body: InteractionMessageUpdateBodyRequest,
  ): Promise<WebhookMessage>

  Parameters

  • messageId: string
  • body: InteractionMessageUpdateBodyRequest

  Returns Promise<WebhookMessage>

editOrReply

• editOrReply<FR extends boolean = false>(
      body: Omit<
          APIInteractionResponseCallbackData,
          "components"
          | "content"
          | "embeds"
          | "poll",
      > & SendResolverProps,
      fetchReply?: FR,
  ): Promise<When<FR, WebhookMessage, void>>

  Type Parameters

  • FR extends boolean = false

  Parameters

  • body: Omit<
        APIInteractionResponseCallbackData,
        "components"
        | "content"
        | "embeds"
        | "poll",
    > & SendResolverProps
  • OptionalfetchReply: FR

  Returns Promise<When<FR, WebhookMessage, void>>

editResponse

• editResponse(body: InteractionMessageUpdateBodyRequest): Promise<WebhookMessage>

  Parameters

  • body: InteractionMessageUpdateBodyRequest

  Returns Promise<WebhookMessage>

fetchGuild

• fetchGuild(mode?: "rest" | "flow"): Promise<undefined | Guild<"cached" | "api">>

  Parameters

  • Optionalmode: "rest" | "flow"

  Returns Promise<undefined | Guild<"cached" | "api">>

• fetchGuild(mode: "cache"): ReturnCache<undefined | Guild<"cached">>

  Parameters

  • mode: "cache"

  Returns ReturnCache<undefined | Guild<"cached">>

fetchMessage

• fetchMessage(messageId: string): Promise<WebhookMessage>

  Parameters

  • messageId: string

  Returns Promise<WebhookMessage>

fetchResponse

• fetchResponse(): Promise<WebhookMessage>

  Returns Promise<WebhookMessage>

followup

• followup(
      body: Omit<
          RESTPostAPIWebhookWithTokenJSONBody,
          "components"
          | "content"
          | "embeds"
          | "poll",
      > & SendResolverProps,
  ): Promise<WebhookMessage>

  Parameters

  • body: Omit<
        RESTPostAPIWebhookWithTokenJSONBody,
        "components"
        | "content"
        | "embeds"
        | "poll",
    > & SendResolverProps

  Returns Promise<WebhookMessage>

isAutocomplete

• isAutocomplete(): this is AutocompleteInteraction<boolean>

  Returns this is AutocompleteInteraction<boolean>

isButton

• isButton(): this is ButtonInteraction

  Returns this is ButtonInteraction

isChannelSelectMenu

• isChannelSelectMenu(): this is ChannelSelectMenuInteraction

  Returns this is ChannelSelectMenuInteraction

isChatInput

• isChatInput(): this is ChatInputCommandInteraction<boolean>

  Returns this is ChatInputCommandInteraction<boolean>

isEntryPoint

• isEntryPoint(): this is EntryPointInteraction<boolean>

  Returns this is EntryPointInteraction<boolean>

isMentionableSelectMenu

• isMentionableSelectMenu(): this is MentionableSelectMenuInteraction

  Returns this is MentionableSelectMenuInteraction

isMessage

• isMessage(): this is MessageCommandInteraction<boolean>

  Returns this is MessageCommandInteraction<boolean>

isModal

• isModal(): this is ModalSubmitInteraction<boolean>

  Returns this is ModalSubmitInteraction<boolean>

isRoleSelectMenu

• isRoleSelectMenu(): this is RoleSelectMenuInteraction

  Returns this is RoleSelectMenuInteraction

isStringSelectMenu

• isStringSelectMenu(): this is StringSelectMenuInteraction<string[]>

  Returns this is StringSelectMenuInteraction<string[]>

isUser

• isUser(): this is UserCommandInteraction<boolean>

  Returns this is UserCommandInteraction<boolean>

isUserSelectMenu

• isUserSelectMenu(): this is UserSelectMenuInteraction

  Returns this is UserSelectMenuInteraction

modal

• modal(body: ModalCreateBodyRequest, options?: undefined): Promise<undefined>

  Parameters

  • body: ModalCreateBodyRequest
  • Optionaloptions: undefined

  Returns Promise<undefined>

• modal(
      body: ModalCreateBodyRequest,
      options: ModalCreateOptions,
  ): Promise<null | ModalSubmitInteraction<boolean>>

  Parameters

  • body: ModalCreateBodyRequest
  • options: ModalCreateOptions

  Returns Promise<null | ModalSubmitInteraction<boolean>>

reply

• reply<WR extends boolean = false>(
      body: ReplyInteractionBody,
      withResponse?: WR,
  ): Promise<When<WR, WebhookMessage, undefined>>

  Type Parameters

  • WR extends boolean = false

  Parameters

  • body: ReplyInteractionBody
  • OptionalwithResponse: WR

  Returns Promise<When<WR, WebhookMessage, undefined>>

update

• update(
      data: Omit<
          APIInteractionResponseCallbackData,
          "components"
          | "content"
          | "embeds",
      > & ResolverProps,
  ): Promise<undefined>

  Parameters

  • data: Omit<APIInteractionResponseCallbackData, "components" | "content" | "embeds"> & ResolverProps

  Returns Promise<undefined>

write

• write<FR extends boolean = false>(
      body: Omit<
          APIInteractionResponseCallbackData,
          "components"
          | "content"
          | "embeds"
          | "poll",
      > & SendResolverProps,
      withResponse?: FR,
  ): Promise<When<FR, WebhookMessage, void>>

  Type Parameters

  • FR extends boolean = false

  Parameters

  • body: Omit<
        APIInteractionResponseCallbackData,
        "components"
        | "content"
        | "embeds"
        | "poll",
    > & SendResolverProps
  • OptionalwithResponse: FR

  Returns Promise<When<FR, WebhookMessage, void>>

Staticfrom

• from(
      client: UsingClient,
      gateway: APIInteraction,
      __reply?: __InternalReplyFunction,
  ):
      | undefined
      | ModalSubmitInteraction<boolean>
      | ButtonInteraction
      | ChannelSelectMenuInteraction
      | RoleSelectMenuInteraction
      | MentionableSelectMenuInteraction
      | UserSelectMenuInteraction
      | StringSelectMenuInteraction<string[]>
      | ChatInputCommandInteraction<boolean>
      | UserCommandInteraction<boolean>
      | MessageCommandInteraction<boolean>
      | AutocompleteInteraction<boolean>
      | BaseInteraction<boolean, APIPingInteraction>

  Parameters

  • client: UsingClient
  • gateway: APIInteraction
  • Optional__reply: __InternalReplyFunction

  Returns
      | undefined
      | ModalSubmitInteraction<boolean>
      | ButtonInteraction
      | ChannelSelectMenuInteraction
      | RoleSelectMenuInteraction
      | MentionableSelectMenuInteraction
      | UserSelectMenuInteraction
      | StringSelectMenuInteraction<string[]>
      | ChatInputCommandInteraction<boolean>
      | UserCommandInteraction<boolean>
      | MessageCommandInteraction<boolean>
      | AutocompleteInteraction<boolean>
      | BaseInteraction<boolean, APIPingInteraction>

StatictransformBody

• transformBody<T>(
      body:
          | Omit<
              RESTPostAPIChannelMessageJSONBody,
              "components"
              | "content"
              | "embeds"
              | "poll",
          > & SendResolverProps
          | Omit<
              APIInteractionResponseCallbackData,
              "components"
              | "content"
              | "embeds"
              | "poll",
          > & SendResolverProps
          | InteractionMessageUpdateBodyRequest
          | Omit<
              RESTPatchAPIChannelMessageJSONBody,
              "components"
              | "content"
              | "embeds",
          > & ResolverProps
          | Omit<
              RESTPostAPIWebhookWithTokenJSONBody,
              "components"
              | "content"
              | "embeds"
              | "poll",
          > & SendResolverProps,
      files: undefined | RawFile[],
      self: UsingClient,
  ): T

  Type Parameters

  • T

  Parameters

  • body:
        | Omit<
            RESTPostAPIChannelMessageJSONBody,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps
        | Omit<
            APIInteractionResponseCallbackData,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps
        | InteractionMessageUpdateBodyRequest
        | Omit<
            RESTPatchAPIChannelMessageJSONBody,
            "components"
            | "content"
            | "embeds",
        > & ResolverProps
        | Omit<
            RESTPostAPIWebhookWithTokenJSONBody,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps
  • files: undefined | RawFile[]
  • self: UsingClient

  Returns T

StatictransformBodyRequest

• transformBodyRequest(
      body: ReplyInteractionBody,
      files: undefined | RawFile[],
      self: UsingClient,
  ): APIInteractionResponse

  Parameters

  • body: ReplyInteractionBody
  • files: undefined | RawFile[]
  • self: UsingClient

  Returns APIInteractionResponse