Represents a TemplateMessage.

Hierarchy

  • TemplateMessage

Implements

Constructors

Properties

contextInfo?: null | IContextInfo

TemplateMessage contextInfo.

format?: "fourRowTemplate" | "hydratedFourRowTemplate" | "interactiveMessageTemplate"

TemplateMessage format.

fourRowTemplate?: null | IFourRowTemplate

TemplateMessage fourRowTemplate.

hydratedFourRowTemplate?: null | IHydratedFourRowTemplate

TemplateMessage hydratedFourRowTemplate.

hydratedTemplate?: null | IHydratedFourRowTemplate

TemplateMessage hydratedTemplate.

interactiveMessageTemplate?: null | IInteractiveMessage

TemplateMessage interactiveMessageTemplate.

templateId: string

TemplateMessage templateId.

Methods

  • Converts this TemplateMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Decodes a TemplateMessage message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

      Message length if known beforehand

    Returns TemplateMessage

    TemplateMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Decodes a TemplateMessage message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns TemplateMessage

    TemplateMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Encodes the specified TemplateMessage message. Does not implicitly verify messages.

    Parameters

    • message: ITemplateMessage

      TemplateMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • Encodes the specified TemplateMessage message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: ITemplateMessage

      TemplateMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • Creates a TemplateMessage message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: {
          [k: string]: any;
      }

      Plain object

      • [k: string]: any

    Returns TemplateMessage

    TemplateMessage

  • Creates a plain object from a TemplateMessage message. Also converts values to other types if specified.

    Parameters

    • message: TemplateMessage

      TemplateMessage

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies a TemplateMessage message.

    Parameters

    • message: {
          [k: string]: any;
      }

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc