Class FlowComponent

Button Component API object for flow button

Hierarchy (View Summary)

ButtonComponent
- FlowComponent

Index

Constructors

Properties

index parameters sub_type type

Constructors

constructor

new FlowComponent(flow_token: string, flow_action_data: unknown): FlowComponent
Creates a button component for a Template message with flow button.
Parameters
- flow_token: string
  Honestly, I don't know what this is, the documentation only says this might be "FLOW_TOKEN" and defaults to "unused".
- flow_action_data: unknown
  JSON object with the data payload for the first screen.
Returns FlowComponent
Overrides ButtonComponent.constructor
- Defined in src/messages/template.ts:562

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"

The type of the component