Class Button

constructor

• new Button(): Button

  Creates a button.

  Returns Button

custom_id

disabled

emoji

label

style

type

url

setCustomID

• setCustomID(id: string): Button

  Set the custom id of the button.

  Parameters

  • id: string

    The custom id of the button.

  Returns Button

  See

  https://discord.com/developers/docs/interactions/message-components#custom-id

setDisabled

• setDisabled(disabled: boolean): Button

  Disables the button from being clickable.

  Parameters

  • disabled: boolean

    Whether this button should be displayed as disabled.

  Returns Button

setEmoji

• setEmoji(emoji: string): Button

  Sets the emoji to be displayed on the button.

  Parameters

  • emoji: string

    The emoji to display on the button. For a custom emoji, it should be in the format "<:bitcoin:844240546246950922>".

  Returns Button

setLabel

• setLabel(label: string): Button

  Sets the text on the button.

  Parameters

  • label: string

    The text to display on the button.

  Returns Button

setStyle

• setStyle(style: ButtonStyle): Button

  Sets the style of the button.

  Parameters

  • style: ButtonStyle

    The button style.

  Returns Button

  See

  https://discord.com/developers/docs/interactions/message-components#button-object-button-styles

setURL

• setURL(url: string): Button

  Sets the url of the button.

  Parameters

  • url: string

    The url for a link button.

  Returns Button

toJSON

• toJSON(
      format?: JsonTypes,
      __namedParameters?: { suppressValidation: boolean },
  ): {
      custom_id: undefined | string;
      disabled: undefined | boolean;
      emoji: undefined | ResolvedEmoji;
      label: undefined | string;
      style: ButtonStyle;
      type: Button;
      url: undefined | string;
  }

  Returns the correct Discord format for a button.

  Parameters

  • Optionalformat: JsonTypes
  • __namedParameters: { suppressValidation: boolean } = ...

  Returns {
      custom_id: undefined | string;
      disabled: undefined | boolean;
      emoji: undefined | ResolvedEmoji;
      label: undefined | string;
      style: ButtonStyle;
      type: Button;
      url: undefined | string;
  }