Class Header

Header API object

Index

Constructors

Properties

document? image? text? type video?

Constructors

constructor

new Header(object): Header
Builds a header component for an Interactive message
Parameters
- object:
      | string
      | Document
      | Image
      | Video
  The message object for the header
Returns Header
Throws
If object is a string and is over 60 characters

Throws
If object is a Media and has a caption
- Defined in src/messages/interactive.ts:429

Properties

`Optional` `Readonly`document

document?: Document

The document of the parameter

`Optional` `Readonly`image

image?: Image

The image of the parameter

`Optional` `Readonly`text

text?: string

The text of the parameter

`Readonly`type

type:
    | "text"
    | "document"
    | "image"
    | "video"

The type of the header

`Optional` `Readonly`video

video?: Video

The video of the parameter