Represents a SessionStructure.

Hierarchy

  • SessionStructure

Implements

Constructors

Properties

aliceBaseKey: Uint8Array

SessionStructure aliceBaseKey.

localIdentityPublic: Uint8Array

SessionStructure localIdentityPublic.

localRegistrationId: number

SessionStructure localRegistrationId.

needsRefresh: boolean

SessionStructure needsRefresh.

pendingKeyExchange?: null | IPendingKeyExchange

SessionStructure pendingKeyExchange.

pendingPreKey?: null | IPendingPreKey

SessionStructure pendingPreKey.

previousCounter: number

SessionStructure previousCounter.

receiverChains: IChain[]

SessionStructure receiverChains.

remoteIdentityPublic: Uint8Array

SessionStructure remoteIdentityPublic.

remoteRegistrationId: number

SessionStructure remoteRegistrationId.

rootKey: Uint8Array

SessionStructure rootKey.

senderChain?: null | IChain

SessionStructure senderChain.

sessionVersion: number

SessionStructure sessionVersion.

Methods

  • Converts this SessionStructure to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

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

    SessionStructure

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns SessionStructure

    SessionStructure

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: ISessionStructure

      SessionStructure message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

    • message: ISessionStructure

      SessionStructure message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns SessionStructure

    SessionStructure

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

    Parameters

    • message: SessionStructure

      SessionStructure

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

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