Class PayloadComponent

Button Component API object for quick reply buttons

Hierarchy (view full)

ButtonComponent
- PayloadComponent

Index

Constructors

Properties

index parameters sub_type type

Constructors

constructor

new PayloadComponent(parameter): PayloadComponent
Creates a button component for a Template message with quick reply buttons.
Parameters
- parameter: string
  Parameter for the component.
Returns PayloadComponent
Throws
If parameter is an empty string.
Overrides ButtonComponent.constructor
- Defined in src/messages/template.ts:388

Properties

`Protected`index

index: number = NaN

The index of the component (assigned after calling _build)

`Readonly`parameters

parameters: [ButtonParameter]

The parameter of the component

`Readonly`sub_type

sub_type:
    | "flow"
    | "url"
    | "quick_reply"
    | "catalog"
    | "mpm"
    | "copy_code"

The subtype of the component

`Readonly`type

type: "button" = "button"

The type of the component