Represents a HighlyStructuredMessage.

Hierarchy

  • HighlyStructuredMessage

Implements

Constructors

Properties

deterministicLc: string

HighlyStructuredMessage deterministicLc.

deterministicLg: string

HighlyStructuredMessage deterministicLg.

elementName: string

HighlyStructuredMessage elementName.

fallbackLc: string

HighlyStructuredMessage fallbackLc.

fallbackLg: string

HighlyStructuredMessage fallbackLg.

hydratedHsm?: null | ITemplateMessage

HighlyStructuredMessage hydratedHsm.

localizableParams: IHSMLocalizableParameter[]

HighlyStructuredMessage localizableParams.

namespace: string

HighlyStructuredMessage namespace.

params: string[]

HighlyStructuredMessage params.

Methods

  • Converts this HighlyStructuredMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Decodes a HighlyStructuredMessage 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 HighlyStructuredMessage

    HighlyStructuredMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns HighlyStructuredMessage

    HighlyStructuredMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: IHighlyStructuredMessage

      HighlyStructuredMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

    • message: IHighlyStructuredMessage

      HighlyStructuredMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies a HighlyStructuredMessage 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