Class: KeyExchangeMessage
Defined in: WAProto/index.d.ts:15488
Represents a KeyExchangeMessage.
Implements
Constructors
new KeyExchangeMessage()
new KeyExchangeMessage(
properties?):KeyExchangeMessage
Defined in: WAProto/index.d.ts:15494
Constructs a new KeyExchangeMessage.
Parameters
properties?
Properties to set
Returns
Properties
baseKey?
optionalbaseKey:null|Uint8Array<ArrayBufferLike>
Defined in: WAProto/index.d.ts:15500
KeyExchangeMessage baseKey.
Implementation of
baseKeySignature?
optionalbaseKeySignature:null|Uint8Array<ArrayBufferLike>
Defined in: WAProto/index.d.ts:15509
KeyExchangeMessage baseKeySignature.
Implementation of
IKeyExchangeMessage.baseKeySignature
id?
optionalid:null|number
Defined in: WAProto/index.d.ts:15497
KeyExchangeMessage id.
Implementation of
identityKey?
optionalidentityKey:null|Uint8Array<ArrayBufferLike>
Defined in: WAProto/index.d.ts:15506
KeyExchangeMessage identityKey.
Implementation of
IKeyExchangeMessage.identityKey
ratchetKey?
optionalratchetKey:null|Uint8Array<ArrayBufferLike>
Defined in: WAProto/index.d.ts:15503
KeyExchangeMessage ratchetKey.
Implementation of
IKeyExchangeMessage.ratchetKey
Methods
toJSON()
toJSON():
object
Defined in: WAProto/index.d.ts:15579
Converts this KeyExchangeMessage to JSON.
Returns
object
JSON object
create()
staticcreate(properties?):KeyExchangeMessage
Defined in: WAProto/index.d.ts:15516
Creates a new KeyExchangeMessage instance using the specified properties.
Parameters
properties?
Properties to set
Returns
KeyExchangeMessage instance
decode()
staticdecode(reader,length?):KeyExchangeMessage
Defined in: WAProto/index.d.ts:15542
Decodes a KeyExchangeMessage 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
KeyExchangeMessage
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):KeyExchangeMessage
Defined in: WAProto/index.d.ts:15551
Decodes a KeyExchangeMessage message from the specified reader or buffer, length delimited.
Parameters
reader
Reader or buffer to decode from
Uint8Array<ArrayBufferLike> | Reader
Returns
KeyExchangeMessage
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Defined in: WAProto/index.d.ts:15524
Encodes the specified KeyExchangeMessage message. Does not implicitly verify messages.
Parameters
message
KeyExchangeMessage message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Defined in: WAProto/index.d.ts:15532
Encodes the specified KeyExchangeMessage message, length delimited. Does not implicitly verify messages.
Parameters
message
KeyExchangeMessage message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):KeyExchangeMessage
Defined in: WAProto/index.d.ts:15565
Creates a KeyExchangeMessage message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
KeyExchangeMessage
getTypeUrl()
staticgetTypeUrl(typeUrlPrefix?):string
Defined in: WAProto/index.d.ts:15586
Gets the default type url for KeyExchangeMessage
Parameters
typeUrlPrefix?
string
your custom typeUrlPrefix(default "type.googleapis.com")
Returns
string
The default type url
toObject()
statictoObject(message,options?):object
Defined in: WAProto/index.d.ts:15573
Creates a plain object from a KeyExchangeMessage message. Also converts values to other types if specified.
Parameters
message
KeyExchangeMessage
options?
IConversionOptions
Conversion options
Returns
object
Plain object
verify()
staticverify(message):null|string
Defined in: WAProto/index.d.ts:15558
Verifies a KeyExchangeMessage message.
Parameters
message
Plain object to verify
Returns
null | string
null if valid, otherwise the reason why it is not