Class Button

Hierarchy

Button

Index

Constructors

Properties

button callback customId? id rawRequires requires

Methods

call getButton handle register

Constructors

constructor

new Button(data: InteractionButtonData | LinkButtonData): Button
Create a new button handler.
Parameters
- data: InteractionButtonData | LinkButtonData
  
  The data to create the button with.
Returns Button
- Defined in src/structures/v14/Button.ts:42

Properties

`Private` button

button: ButtonBuilder

The built button.

`Private` callback

callback: ((button: ButtonInteraction<CacheType>) => void)

Type declaration

- (button: ButtonInteraction<CacheType>): void
- The callback to call when the button is pressed.
  Parameters
  - button: ButtonInteraction<CacheType>
  Returns void

`Optional` customId

customId?: string

The identifier of button interaction.

id

id: string

The identifier of the button to get from the client.

`Private` rawRequires

rawRequires: string[]

The raw requirements before load.

requires

requires: (undefined | Requirement)[]

The requirements of the button.

Methods

call

call(button: ButtonInteraction<CacheType>): Promise<undefined | Button>
Call the callback.
Parameters
- button: ButtonInteraction<CacheType>
  
  The button that was pressed.
Returns Promise<undefined | Button>
- Defined in src/structures/v14/Button.ts:82

getButton

getButton(): ButtonBuilder
Get the button.

Returns ButtonBuilder
- Defined in src/structures/v14/Button.ts:64

handle

handle(callback: ((button: ButtonInteraction<CacheType>) => void)): Button
Set the callback to call when the button is pressed.
Parameters
- callback: ((button: ButtonInteraction<CacheType>) => void)
  
  The callback to call when the button is pressed.
  - - (button: ButtonInteraction<CacheType>): void
    - Parameters
      
      button: ButtonInteraction<CacheType>
      
      Returns void
Returns Button
- Defined in src/structures/v14/Button.ts:72

register

register(client: KommandoClient): Button
Register the button to the client.
Parameters
- client: KommandoClient
  
  The client to register the button to.
Returns Button
- Defined in src/structures/v14/Button.ts:55

Generated using TypeDoc