Class ButtonBuilder

Readonlydata

setDisabled

• setDisabled(disabled?): this

• Sets whether this button is disabled.

  Parameters

  • Optionaldisabled: boolean

    Whether to disable this button

  Returns this

setEmoji

• setEmoji(emoji): this

• Sets the emoji to display on this button.

  Parameters

  • emoji: ComponentEmojiResolvable

    The emoji to use

  Returns this

setLabel

• setLabel(label): this

• Sets the label for this button.

  Parameters

  • label: string

    The label to use

  Returns this

setSKUId

• setSKUId(skuId): this

• Sets the SKU id that represents a purchasable SKU for this button.

  Parameters

  • skuId: string

    The SKU id to use

  Returns this

  Remarks

  Only available when using premium-style buttons.

setStyle

• setStyle(style): this

• Sets the style of this button.

  Parameters

  • style: ButtonStyle

    The style to use

  Returns this

setURL

• setURL(url): this

• Sets the URL for this button.

  Parameters

  • url: string

    The URL to use

  Returns this

  Remarks

  This method is only available to buttons using the Link button style. Only three types of URL schemes are currently supported: https://, http://, and discord://.

toJSON

• toJSON(): APIButtonComponent

• {@inheritDoc ComponentBuilder.toJSON}

  Returns APIButtonComponent

Staticfrom

• from(other): ButtonBuilder

• Parameters

  • other: APIButtonComponent | JSONEncodable<APIButtonComponent>

  Returns ButtonBuilder