Represents a CollectionMessage.

Hierarchy

  • CollectionMessage

Implements

Constructors

Properties

bizJid: string

CollectionMessage bizJid.

id: string

CollectionMessage id.

messageVersion: number

CollectionMessage messageVersion.

Methods

  • Converts this CollectionMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

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

    CollectionMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns CollectionMessage

    CollectionMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: ICollectionMessage

      CollectionMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

    • message: ICollectionMessage

      CollectionMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns CollectionMessage

    CollectionMessage

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

    Parameters

    • message: CollectionMessage

      CollectionMessage

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

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