Class HeaderParameter

Parameter API object

Index

Constructors

Properties

currency? date_time? document? image? location? product? text? type video?

Constructors

constructor

new HeaderParameter(
    parameter:
        | string
        | Location
        | Document
        | Image
        | Video
        | CatalogProduct
        | Currency
        | DateTime,
): HeaderParameter
Builds a parameter object for a HeaderComponent. For text parameter, the character limit is 60. For Document parameter, only PDF documents are supported for document-based message templates (not checked). For Location parameter, the location must have a name and address.
Parameters
- parameter:
      | string
      | Location
      | Document
      | Image
      | Video
      | CatalogProduct
      | Currency
      | DateTime
  The parameter to be used in the template's header
Returns HeaderParameter
Throws
If parameter is a string and it's over 60 characters

Throws
If parameter is a Location and it doesn't have a name and address
- Defined in src/messages/template.ts:711

Properties

`Optional` `Readonly`currency

currency?: Currency

The currency of the parameter

`Optional` `Readonly`date_time

date_time?: DateTime

The datetime of the parameter

`Optional` `Readonly`document

document?: Document

The document of the parameter

`Optional` `Readonly`image

image?: Image

The image of the parameter

`Optional` `Readonly`location

location?: Location

The location of the parameter

`Optional` `Readonly`product

product?: CatalogProduct

The product of the parameter

`Optional` `Readonly`text

text?: string

The text of the parameter

`Readonly`type

type:
    | "text"
    | "document"
    | "image"
    | "video"
    | "location"
    | "product"
    | "currency"
    | "date_time"

The type of the parameter

`Optional` `Readonly`video

video?: Video

The video of the parameter