Class Interactive

Interactive API object

Hierarchy

ClientMessage
- Interactive

Index

Constructors

Properties

action body? footer? header? type

Methods

Constructors

constructor

new Interactive(action, body?, header?, footer?): Interactive
Create an Interactive object for the API
Parameters
- action: InteractiveAction
  The action component of the interactive message
- Optional body: Body
  The body component of the interactive message, it may be undefined if not needed.
- Optional header: Header
  The header component of the interactive message, it may be undefined if not needed.
- Optional footer: Footer
  The footer component of the interactive message, it may be undefined if not needed.
Returns Interactive
Throws
If body is not provided, unless action is an ActionProduct with a single product

Throws
If header is provided for an ActionProduct with a single product

Throws
If header of type text is not provided for an ActionProduct with a product list

Throws
If header is not of type text, unless action is an ActionButtons
Overrides ClientMessage.constructor
- Defined in src/messages/interactive.ts:61

Properties

`Readonly` action

action: InteractiveAction

The action component of the interactive message

`Optional` `Readonly` body

body?: Body

The body component of the interactive message

`Optional` `Readonly` footer

footer?: Footer

The footer component of the interactive message

`Optional` `Readonly` header

header?: Header

The header component of the interactive message

`Readonly` type

type: "list" | "button" | "catalog_message" | "product" | "product_list" | "cta_url" | "flow"

The type of the interactive message

Methods

_build

_build(): string
The message built as a string. In most cases it's just JSON.stringify(this)

Returns string
Inherited from ClientMessage._build
- Defined in src/types.ts:153

Generated using TypeDoc