Class HeaderParameter

constructor

• new HeaderParameter(
      parameter:
          | string
          | Location
          | Document
          | Image
          | Video
          | CatalogProduct
          | Currency
          | DateTime,
      parameter_name?: string,
  ): 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. Both Header and Body components must use the same type of variables, either named or numbered.

  Parameters

  • parameter:
        | string
        | Location
        | Document
        | Image
        | Video
        | CatalogProduct
        | Currency
        | DateTime

    The parameter to be used in the template's header

  • Optionalparameter_name: string

    Name of the parameter, optional if using numbered variables

  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

  Throws

  If parameter_name is over 20 characters long or contains invalid characters (only lowercase a-z and _ are allowed)

Optional Readonlycurrency

Optional Readonlydate_time

Optional Readonlydocument

Optional Readonlyimage

Optional Readonlylocation

Optional Readonlyproduct

Optional Readonlytext

Readonlytype

Optional Readonlyvideo