Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TemplateMessage

Represents a TemplateMessage.

Hierarchy

  • TemplateMessage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional contextInfo

contextInfo: IContextInfo

TemplateMessage contextInfo.

Optional format

format: "fourRowTemplate" | "hydratedFourRowTemplate"

TemplateMessage format.

Optional fourRowTemplate

fourRowTemplate: IFourRowTemplate

TemplateMessage fourRowTemplate.

Optional hydratedFourRowTemplate

hydratedFourRowTemplate: IHydratedFourRowTemplate

TemplateMessage hydratedFourRowTemplate.

Optional hydratedTemplate

hydratedTemplate: IHydratedFourRowTemplate

TemplateMessage hydratedTemplate.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns TemplateMessage

    TemplateMessage

Static decodeDelimited

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns TemplateMessage

    TemplateMessage

Static encode

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

    Parameters

    • message: ITemplateMessage

      TemplateMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

  • 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

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns TemplateMessage

    TemplateMessage

Static toObject

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

    Parameters

    • message: TemplateMessage

      TemplateMessage

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a TemplateMessage message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc