Class: SenderKeyMessage
Defined in: WAProto/index.d.ts:38336
Represents a SenderKeyMessage.
Implements
Constructors
new SenderKeyMessage()
new SenderKeyMessage(
properties?):SenderKeyMessage
Defined in: WAProto/index.d.ts:38342
Constructs a new SenderKeyMessage.
Parameters
properties?
Properties to set
Returns
Properties
ciphertext?
optionalciphertext:null|Uint8Array<ArrayBufferLike>
Defined in: WAProto/index.d.ts:38351
SenderKeyMessage ciphertext.
Implementation of
id?
optionalid:null|number
Defined in: WAProto/index.d.ts:38345
SenderKeyMessage id.
Implementation of
iteration?
optionaliteration:null|number
Defined in: WAProto/index.d.ts:38348
SenderKeyMessage iteration.
Implementation of
Methods
toJSON()
toJSON():
object
Defined in: WAProto/index.d.ts:38421
Converts this SenderKeyMessage to JSON.
Returns
object
JSON object
create()
staticcreate(properties?):SenderKeyMessage
Defined in: WAProto/index.d.ts:38358
Creates a new SenderKeyMessage instance using the specified properties.
Parameters
properties?
Properties to set
Returns
SenderKeyMessage instance
decode()
staticdecode(reader,length?):SenderKeyMessage
Defined in: WAProto/index.d.ts:38384
Decodes a SenderKeyMessage 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
SenderKeyMessage
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):SenderKeyMessage
Defined in: WAProto/index.d.ts:38393
Decodes a SenderKeyMessage message from the specified reader or buffer, length delimited.
Parameters
reader
Reader or buffer to decode from
Uint8Array<ArrayBufferLike> | Reader
Returns
SenderKeyMessage
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:38366
Encodes the specified SenderKeyMessage message. Does not implicitly verify messages.
Parameters
message
SenderKeyMessage 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:38374
Encodes the specified SenderKeyMessage message, length delimited. Does not implicitly verify messages.
Parameters
message
SenderKeyMessage message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):SenderKeyMessage
Defined in: WAProto/index.d.ts:38407
Creates a SenderKeyMessage message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
SenderKeyMessage
getTypeUrl()
staticgetTypeUrl(typeUrlPrefix?):string
Defined in: WAProto/index.d.ts:38428
Gets the default type url for SenderKeyMessage
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:38415
Creates a plain object from a SenderKeyMessage message. Also converts values to other types if specified.
Parameters
message
SenderKeyMessage
options?
IConversionOptions
Conversion options
Returns
object
Plain object
verify()
staticverify(message):null|string
Defined in: WAProto/index.d.ts:38400
Verifies a SenderKeyMessage message.
Parameters
message
Plain object to verify
Returns
null | string
null if valid, otherwise the reason why it is not