Class ButtonBuilder

Readonly data

setCustomId

• setCustomId(customId): ButtonBuilder

• Sets the custom id for this button.

  Parameters

  • customId: string

    The custom id to use

  Returns ButtonBuilder

  Remarks

  This method is only applicable to buttons that are not using the Link button style.

setDisabled

• setDisabled(disabled?): ButtonBuilder

• Sets whether this button is disabled.

  Parameters

  • Optional disabled: boolean

    Whether to disable this button

  Returns ButtonBuilder

setLabel

• setLabel(label): ButtonBuilder

• Sets the label for this button.

  Parameters

  • label: string

    The label to use

  Returns ButtonBuilder

setSKUId

• setSKUId(skuId): ButtonBuilder

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

  Parameters

  • skuId: string

    The SKU id to use

  Returns ButtonBuilder

  Remarks

  Only available when using premium-style buttons.

setStyle

• setStyle(style): ButtonBuilder

• Sets the style of this button.

  Parameters

  • style: ButtonStyle

    The style to use

  Returns ButtonBuilder

setURL

• setURL(url): ButtonBuilder

• Sets the URL for this button.

  Parameters

  • url: string

    The URL to use

  Returns ButtonBuilder

  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

• Serializes this builder to API-compatible JSON data.

  Returns APIButtonComponent

  Remarks

  This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.