Interface PrivateComponentButtonInteraction

createFollowup

• createFollowup(options): Promise<Message<Uncached | AnyPrivateChannel>>

• Create a followup message.

  Parameters

  • options: InteractionContent

    The options for creating the followup message.

  Returns Promise<Message<Uncached | AnyPrivateChannel>>

createMessage

• createMessage(options): Promise<void>

• Create a message through this interaction. This is an initial response, and more than one initial response cannot be used. Use createFollowup.

  Parameters

  • options: InitialInteractionContent

    The options for the message.

  Returns Promise<void>

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

• Edit a followup message.

  Parameters

  • messageID: string

    The ID of the message.

  • options: InteractionContent

    The options for editing the followup message.

  Returns Promise<Message<Uncached | AnyPrivateChannel>>

editOriginal

• editOriginal(options): Promise<Message<Uncached | AnyPrivateChannel>>

• Edit the original interaction response.

  Parameters

  • options: InteractionContent

    The options for editing the original message.

  Returns Promise<Message<Uncached | AnyPrivateChannel>>

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

• Get a followup message.

  Parameters

  • messageID: string

    The ID of the message.

  Returns Promise<Message<Uncached | AnyPrivateChannel>>

getOriginal

• getOriginal(): Promise<Message<Uncached | AnyPrivateChannel>>

• Get the original interaction response.

  Returns Promise<Message<Uncached | AnyPrivateChannel>>

inCachedGuildChannel

• inCachedGuildChannel(): this is ComponentInteraction<BUTTON, 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<BUTTON, AnyTextableGuildChannel>

inPrivateChannel

• inPrivateChannel(): this is ComponentInteraction<BUTTON, 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<BUTTON, PrivateChannel | Uncached>

isButtonComponentInteraction

• isButtonComponentInteraction(): this is ComponentInteraction<BUTTON, Uncached | AnyPrivateChannel>

• 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, Uncached | AnyPrivateChannel>

isSelectMenuComponentInteraction

• isSelectMenuComponentInteraction(): this is ComponentInteraction<SelectMenuTypes, Uncached | AnyPrivateChannel>

• 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, Uncached | AnyPrivateChannel>

toJSON

• toJSON(): JSONComponentInteraction

• Returns JSONComponentInteraction

acknowledged

appPermissions

Optional application

applicationID

channel

channelID

client

createdAt

data

guild

guildID

guildLocale

guildPartial

id

locale

member

memberPermissions

message

token

type

user

version