Class MessageAssociation

Represents a MessageAssociation.

Hierarchy

  • MessageAssociation

Implements

Constructors

Properties

associationType?: null | AssociationType

MessageAssociation associationType.

messageIndex?: null | number

MessageAssociation messageIndex.

parentMessageKey?: null | proto.IMessageKey

MessageAssociation parentMessageKey.

Methods

  • Converts this MessageAssociation to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

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

    MessageAssociation

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns MessageAssociation

    MessageAssociation

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: IMessageAssociation

      MessageAssociation message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

    • message: IMessageAssociation

      MessageAssociation message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns MessageAssociation

    MessageAssociation

  • Gets the default type url for MessageAssociation

    Parameters

    • Optional typeUrlPrefix: string

      your custom typeUrlPrefix(default "type.googleapis.com")

    Returns string

    The default type url

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

    Parameters

    • message: MessageAssociation

      MessageAssociation

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

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