Class ComponentInteraction<V, T>

constructor

• new ComponentInteraction<V, T>(data, client): ComponentInteraction<V, T>

• Type Parameters

  • V extends BUTTON | SelectMenuTypes = BUTTON | SelectMenuTypes
  • T extends Uncached | AnyInteractionChannel = Uncached | AnyInteractionChannel

  Parameters

  • data: RawMessageComponentInteraction
  • client: Client<ClientEvents>

  Returns ComponentInteraction<V, T>

appPermissions

authorizingIntegrationOwners

channelID

Optional context

data

entitlements

guildID

guildLocale

Optional guildPartial

locale

member

memberPermissions

message

type

user

channel

• get channel(): T extends AnyInteractionChannel
      ? T<T>
      : undefined

• The channel this interaction was sent from.

  Returns T extends AnyInteractionChannel
      ? T<T>
      : undefined

guild

• get guild(): T extends AnyTextableGuildChannel
      ? Guild
      : null | Guild

• The guild this interaction was sent from, if applicable. This will throw an error if the guild is not cached.

  Returns T extends AnyTextableGuildChannel
      ? Guild
      : null | Guild

createFollowup

• createFollowup(options): Promise<FollowupMessageInteractionResponse<ComponentInteraction<V, T>>>

• Create a followup message. Note that the returned class is not a message. The message is located in the property message.

  Parameters

  • options: InteractionContent

    The options for creating the followup message.

  Returns Promise<FollowupMessageInteractionResponse<ComponentInteraction<V, T>>>

createMessage

• createMessage(options): Promise<InitialMessagedInteractionResponse<ComponentInteraction<V, T>>>

• Create a message through this interaction. This is an initial response, and more than one initial response cannot be used. Use createFollowup. Note that the returned class is not a message. This initial response does not return a message. You will need to call MessageInteractionResponse#getMessage on the returned class, or getOriginal.

  Parameters

  • options: InitialInteractionContent

    The options for the message.

  Returns Promise<InitialMessagedInteractionResponse<ComponentInteraction<V, T>>>

  Note

  You cannot attach files in an initial response. Defer the interaction, then use createFollowup.

createModal

• createModal(options): Promise<void>

• Respond to this interaction with a modal. This is an initial response, and more than one initial response cannot be used.

  Parameters

  • options: ModalData

    The options for the modal.

  Returns Promise<void>

defer

• defer(flags?): Promise<void>

• Defer this interaction with a DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE response. This is an initial response, and more than one initial response cannot be used.

  Parameters

  • Optional flags: number

    The flags to respond with.

  Returns Promise<void>

deferUpdate

• deferUpdate(flags?): Promise<void>

• Defer this interaction with a DEFERRED_UPDATE_MESSAGE response. This is an initial response, and more than one initial response cannot be used.

  Parameters

  • Optional flags: number

    The flags to respond with.

  Returns Promise<void>

deleteFollowup

• deleteFollowup(messageID): Promise<void>

• Delete a follow-up message.

  Parameters

  • messageID: string

    The ID of the message.

  Returns Promise<void>

deleteOriginal

• deleteOriginal(): Promise<void>

• Delete the original interaction response.

  Returns Promise<void>

editFollowup

• editFollowup(messageID, options): Promise<Message<T>>

• Edit a followup message.

  Parameters

  • messageID: string

    The ID of the message.
  • options: EditInteractionContent

    The options for editing the followup message.

  Returns Promise<Message<T>>

editOriginal

• editOriginal(options): Promise<Message<T>>

• Edit the original interaction response.

  Parameters

  • options: EditInteractionContent

    The options for editing the original message.

  Returns Promise<Message<T>>

editParent

• editParent(options): Promise<void>

• Edit the message this interaction is from. If this interaction has already been acknowledged, use editOriginal.

  Parameters

  • options: InteractionContent

    The options for editing the message.

  Returns Promise<void>

getFollowup

• getFollowup(messageID): Promise<Message<T>>

• Get a followup message.

  Parameters

  • messageID: string

    The ID of the message.

  Returns Promise<Message<T>>

getOriginal

• getOriginal(): Promise<Message<T>>

• Get the original interaction response.

  Returns Promise<Message<T>>

inCachedGuildChannel

• inCachedGuildChannel(): this is ComponentInteraction<V, AnyTextableGuildChannel>

• Whether this interaction belongs to a cached guild channel. The only difference on using this method over a simple if statement is to easily update all the interaction properties typing definitions based on the channel it belongs to.

  Returns this is ComponentInteraction<V, AnyTextableGuildChannel>

inPrivateChannel

• inPrivateChannel(): this is ComponentInteraction<V, PrivateChannel | Uncached>

• Whether this interaction belongs to a private channel (PrivateChannel or uncached). The only difference on using this method over a simple if statement is to easily update all the interaction properties typing definitions based on the channel it belongs to.

  Returns this is ComponentInteraction<V, PrivateChannel | Uncached>

isButtonComponentInteraction

• isButtonComponentInteraction(): this is ComponentInteraction<BUTTON, T>

• Whether this interaction is a button interaction. The only difference on using this method over a simple if statement is to easily update all the interaction properties typing definitions based on the component type.

  Returns this is ComponentInteraction<BUTTON, T>

isSelectMenuComponentInteraction

• isSelectMenuComponentInteraction(): this is ComponentInteraction<SelectMenuTypes, T>

• Whether this interaction is a select menu interaction. The only difference on using this method over a simple if statement is to easily update all the interaction properties typing definitions based on the component type.

  Returns this is ComponentInteraction<SelectMenuTypes, T>

premiumRequired

• premiumRequired(): Promise<void>

• Show a "premium required" response to the user. This is an initial response, and more than one initial response cannot be used.

  Returns Promise<void>

reply

• reply(options): Promise<MessageInteractionResponse<ComponentInteraction<V, T>>>

• Reply to this interaction. If the interaction hasn't been acknowledged, createMessage is used. Else, createFollowup is used. Note the returned class is not a message. Depending on which method was used, the returned class may or may not have the sent message. hasMessage can be used for type narrowing to check if message is present. If it is not, the getMessage can be used.

  Parameters

  • options: InteractionContent

    The options for the message.

  Returns Promise<MessageInteractionResponse<ComponentInteraction<V, T>>>

  Note

  Due to atachments not being able to be sent in initial responses, attachments will cause a deferred response, if the interaction has not been acknowledged.

toJSON

• toJSON(): JSONComponentInteraction

• Returns JSONComponentInteraction