Class: SenderKeyStateStructure

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

Represents a SenderKeyStateStructure.

Implements

• ISenderKeyStateStructure

Constructors

new SenderKeyStateStructure()

new SenderKeyStateStructure(properties?): SenderKeyStateStructure

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

Constructs a new SenderKeyStateStructure.

Parameters

properties?

ISenderKeyStateStructure

Properties to set

Returns

SenderKeyStateStructure

Properties

senderChainKey?

optional senderChainKey: null | ISenderChainKey

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

SenderKeyStateStructure senderChainKey.

Implementation of

ISenderKeyStateStructure.senderChainKey

---

senderKeyId?

optional senderKeyId: null | number

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

SenderKeyStateStructure senderKeyId.

Implementation of

ISenderKeyStateStructure.senderKeyId

---

senderMessageKeys

senderMessageKeys: ISenderMessageKey[]

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

SenderKeyStateStructure senderMessageKeys.

Implementation of

ISenderKeyStateStructure.senderMessageKeys

---

senderSigningKey?

optional senderSigningKey: null | ISenderSigningKey

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

SenderKeyStateStructure senderSigningKey.

Implementation of

ISenderKeyStateStructure.senderSigningKey

Methods

toJSON()

toJSON(): object

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

Converts this SenderKeyStateStructure to JSON.

Returns

object

JSON object

---

create()

static create(properties?): SenderKeyStateStructure

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

Creates a new SenderKeyStateStructure instance using the specified properties.

Parameters

properties?

ISenderKeyStateStructure

Properties to set

Returns

SenderKeyStateStructure

SenderKeyStateStructure instance

---

decode()

static decode(reader, length?): SenderKeyStateStructure

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

Decodes a SenderKeyStateStructure 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

SenderKeyStateStructure

SenderKeyStateStructure

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): SenderKeyStateStructure

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

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

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

SenderKeyStateStructure

SenderKeyStateStructure

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:38578

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

Parameters

message

ISenderKeyStateStructure

SenderKeyStateStructure 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:38586

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

Parameters

message

ISenderKeyStateStructure

SenderKeyStateStructure message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): SenderKeyStateStructure

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

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

Parameters

object

Plain object

Returns

SenderKeyStateStructure

SenderKeyStateStructure

---

getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for SenderKeyStateStructure

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:38627

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

Parameters

message

SenderKeyStateStructure

SenderKeyStateStructure

options?

IConversionOptions

Conversion options

Returns

object

Plain object

---

verify()

static verify(message): null | string

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

Verifies a SenderKeyStateStructure message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not