Class Button

Represents a button component.

Template: Type

The type of the button component.

Hierarchy (View Summary)

BaseComponentBuilder<APIButtonComponent>
- Button

Index

Constructors

Properties

Methods

setCustomId setDisabled setEmoji setLabel setSKUId setStyle setURL toJSON

Constructors

constructor

new Button(data?: Partial<APIButtonComponent>): Button
Parameters
- data: Partial<APIButtonComponent> = {}
Returns Button
Overrides BaseComponentBuilder.constructor
- Defined in src/builders/Button.ts:10

Properties

data

data: Partial<APIButtonComponent> = {}

Methods

setCustomId

setCustomId(id: string): Button
Sets the custom ID for the button.
Parameters
- id: string
  The custom ID to set.
Returns Button
The modified Button instance.
- Defined in src/builders/Button.ts:19

setDisabled

setDisabled(disabled?: boolean): Button
Sets the disabled state of the button.
Parameters
- disabled: boolean = true
  Whether the button should be disabled or not.
Returns Button
The modified Button instance.
- Defined in src/builders/Button.ts:62

setEmoji

setEmoji(emoji: EmojiResolvable): Button
Sets the emoji for the button.
Parameters
- emoji: EmojiResolvable
  The emoji to set.
Returns Button
The modified Button instance.
- Defined in src/builders/Button.ts:49

setLabel

setLabel(label: string): Button
Sets the label for the button.
Parameters
- label: string
  The label to set.
Returns Button
The modified Button instance.
- Defined in src/builders/Button.ts:39

setSKUId

setSKUId(skuId: string): Button
Parameters
- skuId: string
Returns Button
- Defined in src/builders/Button.ts:72

setStyle

setStyle(style: ButtonStyle): Button
Parameters
- style: ButtonStyle
Returns Button
- Defined in src/builders/Button.ts:67

setURL

setURL(url: string): Button
Sets the URL for the button.
Parameters
- url: string
  The URL to set.
Returns Button
The modified Button instance.
- Defined in src/builders/Button.ts:29

toJSON

toJSON(): APIButtonComponent
Returns APIButtonComponent
Inherited from BaseComponentBuilder.toJSON
- Defined in src/builders/Base.ts:8