Class ButtonComponent

constructor

• new ButtonComponent(sub_type, ...parameters): ButtonComponent

• Builds a button component for a Template message. The index of the buttons is defined by the order in which you add them to the Template parameters.

  Parameters

  • sub_type: "url" | "quick_reply"

    The type of button to create.

  • Rest ...parameters: AtLeastOne<string>

    Parameter for each button. The index of each parameter is defined by the order they are sent to the constructor.

  Returns ButtonComponent

  Remarks

  Empty strings are not allowed in the API. However, rather than being ignored or throwing an error, the constructor will use them as dummies for fake variables.

  You might want to know why. So do I. It's a really dumb catch to fix an issue on the API side. If you have a template with 2 buttons, the first one a phone number (which can't take variables), and an url button (which can have variables), the API will throw an error because the first button can't take variables, even though it DOESN'T need a variable.

  For such cases, the expected code would be:

  const template = new Template(
      "name",
      "en_US",
      new ButtonComponent(
          "url",
          "", // As the first button is a phone, skip assigning it a variable
          "?user=123"
      )
  );
  Copy

  Throws

  If parameters is over 3 elements

Readonly parameters

Readonly sub_type

Readonly type

_build

• _build(): BuiltButtonComponent[]

• Returns BuiltButtonComponent[]