Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HighlyStructuredMessage

Represents a HighlyStructuredMessage.

Hierarchy

  • HighlyStructuredMessage

Implements

Index

Constructors

constructor

Properties

deterministicLc

deterministicLc: string

HighlyStructuredMessage deterministicLc.

deterministicLg

deterministicLg: string

HighlyStructuredMessage deterministicLg.

elementName

elementName: string

HighlyStructuredMessage elementName.

fallbackLc

fallbackLc: string

HighlyStructuredMessage fallbackLc.

fallbackLg

fallbackLg: string

HighlyStructuredMessage fallbackLg.

Optional hydratedHsm

hydratedHsm: ITemplateMessage

HighlyStructuredMessage hydratedHsm.

localizableParams

localizableParams: IHSMLocalizableParameter[]

HighlyStructuredMessage localizableParams.

namespace

namespace: string

HighlyStructuredMessage namespace.

params

params: string[]

HighlyStructuredMessage params.

Methods

toJSON

  • toJSON(): {}
  • Converts this HighlyStructuredMessage to JSON.

    Returns {}

    JSON object

    • [k: string]: any

Static create

Static decode

  • Decodes a HighlyStructuredMessage 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 HighlyStructuredMessage

    HighlyStructuredMessage

Static decodeDelimited

  • Decodes a HighlyStructuredMessage 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 HighlyStructuredMessage

    HighlyStructuredMessage

Static encode

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

    Parameters

    Returns Writer

    Writer

Static encodeDelimited

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

    Parameters

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns HighlyStructuredMessage

    HighlyStructuredMessage

Static toObject

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

    Parameters

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string
  • Verifies a HighlyStructuredMessage 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