Class: SignalMessage
Defined in: WAProto/index.d.ts:39819
Represents a SignalMessage.
Implements
Constructors
new SignalMessage()
new SignalMessage(
properties?):SignalMessage
Defined in: WAProto/index.d.ts:39825
Constructs a new SignalMessage.
Parameters
properties?
Properties to set
Returns
Properties
ciphertext?
optionalciphertext:null|Uint8Array<ArrayBufferLike>
Defined in: WAProto/index.d.ts:39837
SignalMessage ciphertext.
Implementation of
counter?
optionalcounter:null|number
Defined in: WAProto/index.d.ts:39831
SignalMessage counter.
Implementation of
previousCounter?
optionalpreviousCounter:null|number
Defined in: WAProto/index.d.ts:39834
SignalMessage previousCounter.
Implementation of
ISignalMessage.previousCounter
ratchetKey?
optionalratchetKey:null|Uint8Array<ArrayBufferLike>
Defined in: WAProto/index.d.ts:39828
SignalMessage ratchetKey.
Implementation of
Methods
toJSON()
toJSON():
object
Defined in: WAProto/index.d.ts:39907
Converts this SignalMessage to JSON.
Returns
object
JSON object
create()
staticcreate(properties?):SignalMessage
Defined in: WAProto/index.d.ts:39844
Creates a new SignalMessage instance using the specified properties.
Parameters
properties?
Properties to set
Returns
SignalMessage instance
decode()
staticdecode(reader,length?):SignalMessage
Defined in: WAProto/index.d.ts:39870
Decodes a SignalMessage 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
SignalMessage
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):SignalMessage
Defined in: WAProto/index.d.ts:39879
Decodes a SignalMessage message from the specified reader or buffer, length delimited.
Parameters
reader
Reader or buffer to decode from
Uint8Array<ArrayBufferLike> | Reader
Returns
SignalMessage
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:39852
Encodes the specified SignalMessage message. Does not implicitly verify messages.
Parameters
message
SignalMessage 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:39860
Encodes the specified SignalMessage message, length delimited. Does not implicitly verify messages.
Parameters
message
SignalMessage message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):SignalMessage
Defined in: WAProto/index.d.ts:39893
Creates a SignalMessage message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
SignalMessage
getTypeUrl()
staticgetTypeUrl(typeUrlPrefix?):string
Defined in: WAProto/index.d.ts:39914
Gets the default type url for SignalMessage
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:39901
Creates a plain object from a SignalMessage message. Also converts values to other types if specified.
Parameters
message
SignalMessage
options?
IConversionOptions
Conversion options
Returns
object
Plain object
verify()
staticverify(message):null|string
Defined in: WAProto/index.d.ts:39886
Verifies a SignalMessage message.
Parameters
message
Plain object to verify
Returns
null | string
null if valid, otherwise the reason why it is not