Class MPMComponent

Button Component API object for Multi-Product Message

Hierarchy (View Summary)

ButtonComponent
- MPMComponent

Index

Constructors

Properties

index parameters sub_type type

Constructors

constructor

new MPMComponent(
thumbnail: Product,
...sections: AtLeastOne<ProductSection>,
): MPMComponent
Creates a button component for a MPM Template.
Parameters
- thumbnail: Product
  The product to use as thumbnail.
- ...sections: AtLeastOne<ProductSection>
  The sections of the MPM. Must have between 1 and 10 sections. Must have less than 30 products across all sections.
Returns MPMComponent
Throws
If sections is over 10 elements.

Throws
If sections is over 1 element and one of the sections doesn't have a title.
Overrides ButtonComponent.constructor
- Defined in src/messages/template.ts:466

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