Class: PreKeySignalMessage

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

Represents a PreKeySignalMessage.

Implements

• IPreKeySignalMessage

Constructors

new PreKeySignalMessage()

new PreKeySignalMessage(properties?): PreKeySignalMessage

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

Constructs a new PreKeySignalMessage.

Parameters

properties?

IPreKeySignalMessage

Properties to set

Returns

PreKeySignalMessage

Properties

baseKey?

optional baseKey: null | Uint8Array<ArrayBufferLike>

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

PreKeySignalMessage baseKey.

Implementation of

IPreKeySignalMessage.baseKey

---

identityKey?

optional identityKey: null | Uint8Array<ArrayBufferLike>

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

PreKeySignalMessage identityKey.

Implementation of

IPreKeySignalMessage.identityKey

---

message?

optional message: null | Uint8Array<ArrayBufferLike>

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

PreKeySignalMessage message.

Implementation of

IPreKeySignalMessage.message

---

preKeyId?

optional preKeyId: null | number

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

PreKeySignalMessage preKeyId.

Implementation of

IPreKeySignalMessage.preKeyId

---

registrationId?

optional registrationId: null | number

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

PreKeySignalMessage registrationId.

Implementation of

IPreKeySignalMessage.registrationId

---

signedPreKeyId?

optional signedPreKeyId: null | number

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

PreKeySignalMessage signedPreKeyId.

Implementation of

IPreKeySignalMessage.signedPreKeyId

Methods

toJSON()

toJSON(): object

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

Converts this PreKeySignalMessage to JSON.

Returns

object

JSON object

---

create()

static create(properties?): PreKeySignalMessage

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

Creates a new PreKeySignalMessage instance using the specified properties.

Parameters

properties?

IPreKeySignalMessage

Properties to set

Returns

PreKeySignalMessage

PreKeySignalMessage instance

---

decode()

static decode(reader, length?): PreKeySignalMessage

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

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

PreKeySignalMessage

PreKeySignalMessage

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): PreKeySignalMessage

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

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

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

PreKeySignalMessage

PreKeySignalMessage

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

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

Parameters

message

IPreKeySignalMessage

PreKeySignalMessage 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:37048

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

Parameters

message

IPreKeySignalMessage

PreKeySignalMessage message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): PreKeySignalMessage

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

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

Parameters

object

Plain object

Returns

PreKeySignalMessage

PreKeySignalMessage

---

getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for PreKeySignalMessage

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

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

Parameters

message

PreKeySignalMessage

PreKeySignalMessage

options?

IConversionOptions

Conversion options

Returns

object

Plain object

---

verify()

static verify(message): null | string

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

Verifies a PreKeySignalMessage message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not