Skip to main content

Class: SessionStructure

Defined in: WAProto/index.d.ts:39096

Represents a SessionStructure.

Implements​

Constructors​

new SessionStructure()​

new SessionStructure(properties?): SessionStructure

Defined in: WAProto/index.d.ts:39102

Constructs a new SessionStructure.

Parameters​

properties?​

ISessionStructure

Properties to set

Returns​

SessionStructure

Properties​

aliceBaseKey?​

optional aliceBaseKey: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:39141

SessionStructure aliceBaseKey.

Implementation of​

ISessionStructure.aliceBaseKey

localIdentityPublic?​

optional localIdentityPublic: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:39108

SessionStructure localIdentityPublic.

Implementation of​

ISessionStructure.localIdentityPublic

localRegistrationId?​

optional localRegistrationId: null | number

Defined in: WAProto/index.d.ts:39135

SessionStructure localRegistrationId.

Implementation of​

ISessionStructure.localRegistrationId

needsRefresh?​

optional needsRefresh: null | boolean

Defined in: WAProto/index.d.ts:39138

SessionStructure needsRefresh.

Implementation of​

ISessionStructure.needsRefresh

pendingKeyExchange?​

optional pendingKeyExchange: null | IPendingKeyExchange

Defined in: WAProto/index.d.ts:39126

SessionStructure pendingKeyExchange.

Implementation of​

ISessionStructure.pendingKeyExchange

pendingPreKey?​

optional pendingPreKey: null | IPendingPreKey

Defined in: WAProto/index.d.ts:39129

SessionStructure pendingPreKey.

Implementation of​

ISessionStructure.pendingPreKey

previousCounter?​

optional previousCounter: null | number

Defined in: WAProto/index.d.ts:39117

SessionStructure previousCounter.

Implementation of​

ISessionStructure.previousCounter

receiverChains​

receiverChains: IChain[]

Defined in: WAProto/index.d.ts:39123

SessionStructure receiverChains.

Implementation of​

ISessionStructure.receiverChains

remoteIdentityPublic?​

optional remoteIdentityPublic: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:39111

SessionStructure remoteIdentityPublic.

Implementation of​

ISessionStructure.remoteIdentityPublic

remoteRegistrationId?​

optional remoteRegistrationId: null | number

Defined in: WAProto/index.d.ts:39132

SessionStructure remoteRegistrationId.

Implementation of​

ISessionStructure.remoteRegistrationId

rootKey?​

optional rootKey: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:39114

SessionStructure rootKey.

Implementation of​

ISessionStructure.rootKey

senderChain?​

optional senderChain: null | IChain

Defined in: WAProto/index.d.ts:39120

SessionStructure senderChain.

Implementation of​

ISessionStructure.senderChain

sessionVersion?​

optional sessionVersion: null | number

Defined in: WAProto/index.d.ts:39105

SessionStructure sessionVersion.

Implementation of​

ISessionStructure.sessionVersion

Methods​

toJSON()​

toJSON(): object

Defined in: WAProto/index.d.ts:39211

Converts this SessionStructure to JSON.

Returns​

object

JSON object

create()​

static create(properties?): SessionStructure

Defined in: WAProto/index.d.ts:39148

Creates a new SessionStructure instance using the specified properties.

Parameters​

properties?​

ISessionStructure

Properties to set

Returns​

SessionStructure

SessionStructure instance

decode()​

static decode(reader, length?): SessionStructure

Defined in: WAProto/index.d.ts:39174

Decodes a SessionStructure message from the specified reader or buffer.

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

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

decodeDelimited()​

static decodeDelimited(reader): SessionStructure

Defined in: WAProto/index.d.ts:39183

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

SessionStructure

SessionStructure

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Defined in: WAProto/index.d.ts:39156

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

Parameters​

message​

ISessionStructure

SessionStructure message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Defined in: WAProto/index.d.ts:39164

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

Parameters​

message​

ISessionStructure

SessionStructure message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SessionStructure

Defined in: WAProto/index.d.ts:39197

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

Parameters​

object​

Plain object

Returns​

SessionStructure

SessionStructure

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

Defined in: WAProto/index.d.ts:39218

Gets the default type url for SessionStructure

Parameters​

typeUrlPrefix?​

string

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

Returns​

string

The default type url

toObject()​

static toObject(message, options?): object

Defined in: WAProto/index.d.ts:39205

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

Parameters​

message​

SessionStructure

SessionStructure

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

Defined in: WAProto/index.d.ts:39190

Verifies a SessionStructure message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not