Class ButtonBuilder

Represents a validated button component

Hierarchy

ButtonBuilder

Index

Constructors

constructor

Properties

data

Accessors

Methods

Constructors

constructor

new ButtonBuilder(data?: APIButtonComponent): ButtonBuilder

- Defined in src/builders/Button.ts:7
Parameters
- Optional data: APIButtonComponent
Returns ButtonBuilder

Properties

data

data: APIButtonComponent

Accessors

customId

get customId(): string

- Defined in src/builders/Button.ts:21
The custom Id of this button

Returns string

disabled

get disabled(): undefined | boolean

- Defined in src/builders/Button.ts:36
Whether this button is disabled

Returns undefined | boolean

label

get label(): undefined | string

- Defined in src/builders/Button.ts:31
The label of this button

Returns undefined | string

style

get style(): ButtonStyle

- Defined in src/builders/Button.ts:41
The style of this button

Returns ButtonStyle

type

get type(): Button

- Defined in src/builders/Button.ts:16
The type of this component

Returns Button

url

get url(): string

- Defined in src/builders/Button.ts:26
The url of this button

Returns string

Methods

setCustomId

setCustomId(customId: string): ButtonBuilder

- Defined in src/builders/Button.ts:88
Sets the custom Id of this button
example
```
button.setCustomId('first_button');
```
Parameters
- customId: string
Returns ButtonBuilder

setDisabled

setDisabled(disabled?: boolean): ButtonBuilder

- Defined in src/builders/Button.ts:76
Sets the disabled state of this button
example
```
button.setDisabled(true);
```
Parameters
- disabled: boolean = true
Returns ButtonBuilder

setEmoji

setEmoji(emoji?: APIMessageComponentEmoji): ButtonBuilder

- Defined in src/builders/Button.ts:116
Sets the emoji to display to the left of the button
example
```
button.setEmoji('😱');
```
example
```
button.setEmoji('<:funny:957998724506857472>');
```
Parameters
- Optional emoji: APIMessageComponentEmoji
Returns ButtonBuilder

setLabel

setLabel(label: string): ButtonBuilder

- Defined in src/builders/Button.ts:64
Sets the label of this button
example
```
button.setLabel('Click here to close the channel');
```
Parameters
- label: string
Returns ButtonBuilder

setStyle

setStyle(style: ButtonStyle): ButtonBuilder

- Defined in src/builders/Button.ts:52
Sets the style of this button
example
```
button.setStyle(ButtonStyle.Primary);
```
Parameters
- style: ButtonStyle
Returns ButtonBuilder

setURL

setURL(url: string): ButtonBuilder

- Defined in src/builders/Button.ts:100
Sets the custom Id of this button
example
```
button.setURL('https://helly.js.org');
```
Parameters
- url: string
Returns ButtonBuilder

toJSON

toJSON(): APIButtonComponent

- Defined in src/builders/Button.ts:122
Returns the raw data of this button

Returns APIButtonComponent

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:15 AM