Class ButtonClick

Represents when a button is clicked.

See

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-message-component-data-structure

Hierarchy (View Summary)

Interaction
- ButtonClick

Implements

ButtonClick

Index

Constructors

constructor

new ButtonClick(
    client: Client,
    data: APIMessageComponentGuildInteraction,
    options: { channelId: string; guildId: string },
): ButtonClick
Creates a button click interaction structure.
Parameters
- client: Client
  The client instance.
- data: APIMessageComponentGuildInteraction
  The interaction data from Discord.
- options: { channelId: string; guildId: string }
  Additional options for this structure.
  - channelId: string
    The ID of the channel that this interaction belongs to.
  - guildId: string
    The ID of the guild that this interaction belongs to.
Returns ButtonClick
Overrides Interaction.constructor
- Defined in src/structures/ButtonClick.ts:40

Accessors

channel

get channel(): AllChannels
The channel that this interaction belongs to.

Returns AllChannels
Implementation of ButtonClickType.channel
Inherited from Interaction.channel
- Defined in src/structures/Interaction.ts:194

channelId

get channelId(): string
The id of the channel that this interaction belongs to.

Returns string
Implementation of ButtonClickType.channelId
Inherited from Interaction.channelId
- Defined in src/structures/Interaction.ts:177

customId

get customId(): string
The custom id of the button.

Returns string
Implementation of ButtonClickType.customId
- Defined in src/structures/ButtonClick.ts:87

guild

get guild(): Guild
The guild that this interaction belongs to.

Returns Guild
Implementation of ButtonClickType.guild
Inherited from Interaction.guild
- Defined in src/structures/Interaction.ts:163

guildId

get guildId(): string
The id of the guild that this interaction belongs to.

Returns string
Implementation of ButtonClickType.guildId
Inherited from Interaction.guildId
- Defined in src/structures/Interaction.ts:153

id

get id(): string
The id of the interaction.

Returns string
Implementation of ButtonClickType.id
Inherited from Interaction.id
- Defined in src/structures/Interaction.ts:123

member

get member(): undefined | null | Member
The member that triggered the interaction, if it was run in a guild.

Returns undefined | null | Member
Implementation of ButtonClickType.member
Inherited from Interaction.member
- Defined in src/structures/Interaction.ts:212

memberId

get memberId(): string
The id of the member that triggered the interaction, if it was run in a guild.

Returns string
Implementation of ButtonClickType.memberId
Inherited from Interaction.memberId
- Defined in src/structures/Interaction.ts:224

message

get message(): Message
The message which the button belongs to.

Returns Message
See
Message
Implementation of ButtonClickType.message
- Defined in src/structures/ButtonClick.ts:98

token

get token(): string
The token of the interaction.

Returns string
Implementation of ButtonClickType.token
Inherited from Interaction.token
- Defined in src/structures/Interaction.ts:133

type

get type(): | ApplicationCommand
| MessageComponent
| ApplicationCommandAutocomplete
| ModalSubmit
The type of interaction.

Returns
    | ApplicationCommand
    | MessageComponent
    | ApplicationCommandAutocomplete
    | ModalSubmit
Implementation of ButtonClickType.type
Inherited from Interaction.type
- Defined in src/structures/Interaction.ts:143

Methods

[custom]

"[custom]"(): string
Returns string
Method
Overrides Interaction.[custom]
- Defined in src/structures/ButtonClick.ts:114

acknowledge

acknowledge(): Promise<ButtonClick>
Silently acknowledges an interaction.

Returns Promise<ButtonClick>
Async
Method
Implementation of ButtonClickType.acknowledge
Inherited from Interaction.acknowledge
- Defined in src/structures/Interaction.ts:419

autocompleteResponse

autocompleteResponse(
options: { choices: CommandChoiceBuilder[] },
): Promise<void>
Responds to autocomplete interactions.
Parameters
- options: { choices: CommandChoiceBuilder[] }
  Autocompletion options.
  - choices: CommandChoiceBuilder[]
    The choices to send back.
Returns Promise<void>
Async
Method
Throws
Implementation of ButtonClickType.autocompleteResponse
Inherited from Interaction.autocompleteResponse
- Defined in src/structures/Interaction.ts:294

delete

delete(): Promise<any>
Deletes a response to an interaction. Works up to 15 minutes after the response was sent.

Returns Promise<any>
Async
Method
Throws
Implementation of ButtonClickType.delete
Inherited from Interaction.delete
- Defined in src/structures/Interaction.ts:442

edit

edit(
    options?: {
        components?: MessageComponents;
        content?: string;
        embeds?: Embed[];
        files?: FileUpload[];
    },
): Promise<any>
Edits a response to an interaction. Works up to 15 minutes after the response was sent.
Parameters
- Optionaloptions: {
      components?: MessageComponents;
      content?: string;
      embeds?: Embed[];
      files?: FileUpload[];
  }
  The new interaction response options.
  - Optionalcomponents?: MessageComponents
    The new components to send with the interaction response.
  - Optionalcontent?: string
    The new content of the interaction response.
  - Optionalembeds?: Embed[]
    The new embeds to send with the interaction response.
  - Optionalfiles?: FileUpload[]
    The new files to send with the interaction response.
Returns Promise<any>
Async
Method
Throws
Implementation of ButtonClickType.edit
Inherited from Interaction.edit
- Defined in src/structures/Interaction.ts:482

reply

reply(
    options?: {
        components?: MessageComponents;
        content?: string;
        embeds?: Embed[];
        files?: FileUpload[];
        quiet?: boolean;
    },
): Promise<ButtonClick>
Replies to an interaction.
Parameters
- Optionaloptions: {
      components?: MessageComponents;
      content?: string;
      embeds?: Embed[];
      files?: FileUpload[];
      quiet?: boolean;
  }
  An embed, components, and whether the response should be as an ephemeral message.
  - Optionalcomponents?: MessageComponents
    The components to send with the interaction response.
  - Optionalcontent?: string
    The content of the interaction response.
  - Optionalembeds?: Embed[]
    The embeds to send with the interaction response.
  - Optionalfiles?: FileUpload[]
    The files to send with the interaction response.
  - Optionalquiet?: boolean
    Whether the response should be an ephemeral message.
Returns Promise<ButtonClick>
Async
Method
Implementation of ButtonClickType.reply
Inherited from Interaction.reply
- Defined in src/structures/Interaction.ts:332

textPrompt

textPrompt(
    options: {
        customId: string;
        textInputModal: TextInputBuilder;
        title: string;
    },
): Promise<void>
Prompts a user to enter text using a modal.
Parameters
- options: { customId: string; textInputModal: TextInputBuilder; title: string }
  Modal options.
  - customId: string
    The custom id of the modal.
  - textInputModal: TextInputBuilder
    The text input modal.
  - title: string
    The title of the modal.
Returns Promise<void>
Async
Method
Throws
Implementation of ButtonClickType.textPrompt
Inherited from Interaction.textPrompt
- Defined in src/structures/Interaction.ts:240

toJSON

toJSON(
format?: JsonTypes,
): ButtonClickCacheJSON | ButtonClickDiscordJSON | ButtonClickStorageJSON
Returns the JSON representation of this structure.
Parameters
- Optionalformat: JsonTypes
  The format to return the data in.
Returns ButtonClickCacheJSON | ButtonClickDiscordJSON | ButtonClickStorageJSON
Method
Implementation of ButtonClickType.toJSON
Overrides Interaction.toJSON
- Defined in src/structures/ButtonClick.ts:126

toString

toString(): string
Returns string
Method
Implementation of ButtonClickType.toString
Overrides Interaction.toString
- Defined in src/structures/ButtonClick.ts:106

`Static`delete

delete(client: Client, interactionToken: string): Promise<any>
Deletes a response to an interaction. Works up to 15 minutes after the response was sent.
Parameters
- client: Client
  The client instance.
- interactionToken: string
  The interaction token.
Returns Promise<any>
Async
Method
Static
Throws
Inherited from Interaction.delete
- Defined in src/structures/Interaction.ts:457

`Static`edit

edit(
    client: Client,
    interactionToken: string,
    options?: {
        components?: MessageComponents;
        content?: string;
        embeds?: Embed[];
        files?: FileUpload[];
    },
): Promise<any>
Edits a response to an interaction. Works up to 15 minutes after the response was sent.
Parameters
- client: Client
  The client instance.
- interactionToken: string
  The interaction token.
- Optionaloptions: {
      components?: MessageComponents;
      content?: string;
      embeds?: Embed[];
      files?: FileUpload[];
  }
  The new interaction response options.
  - Optionalcomponents?: MessageComponents
    The new components to send with the interaction response.
  - Optionalcontent?: string
    The new content of the interaction response.
  - Optionalembeds?: Embed[]
    The new embeds to send with the interaction response.
  - Optionalfiles?: FileUpload[]
    The new files to send with the interaction response.
Returns Promise<any>
Async
Method
Throws
Inherited from Interaction.edit
- Defined in src/structures/Interaction.ts:516

Class ButtonClick

See

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

channelId: string

guildId: string

Returns ButtonClick

Accessors

channel

Returns AllChannels

channelId

Returns string

customId

Returns string

guild

Returns Guild

guildId

Returns string

id

Returns string

member

Returns undefined | null | Member

memberId

Returns string

message

Returns Message

See

token

Returns string

type

Returns | ApplicationCommand | MessageComponent | ApplicationCommandAutocomplete | ModalSubmit

Methods

[custom]

Returns string

Method

acknowledge

Returns Promise<ButtonClick>

Async

Method

autocompleteResponse

Parameters

choices: CommandChoiceBuilder[]

Returns Promise<void>

Async

Method

Throws

delete

Returns Promise<any>

Async

Method

Throws

edit

Parameters

Optionalcomponents?: MessageComponents

Optionalcontent?: string

Optionalembeds?: Embed[]

Optionalfiles?: FileUpload[]

Returns Promise<any>

Async

Method

Throws

reply

Parameters

Optionalcomponents?: MessageComponents

Optionalcontent?: string

Optionalembeds?: Embed[]

Optionalfiles?: FileUpload[]

Optionalquiet?: boolean

Returns Promise<ButtonClick>

Async

Method

textPrompt

Parameters

Returns
| ApplicationCommand
| MessageComponent
| ApplicationCommandAutocomplete
| ModalSubmit

`Optional`components?: MessageComponents

`Optional`content?: string

`Optional`embeds?: Embed[]

`Optional`files?: FileUpload[]

`Optional`components?: MessageComponents

`Optional`content?: string

`Optional`embeds?: Embed[]

`Optional`files?: FileUpload[]

`Optional`quiet?: boolean

`Static`delete

`Static`edit

`Optional`components?: MessageComponents

`Optional`content?: string

`Optional`embeds?: Embed[]

`Optional`files?: FileUpload[]