Class: PreKeyRecordStructure
Defined in: WAProto/index.d.ts:36883
Represents a PreKeyRecordStructure.
Implements
Constructors
new PreKeyRecordStructure()
new PreKeyRecordStructure(
properties?):PreKeyRecordStructure
Defined in: WAProto/index.d.ts:36889
Constructs a new PreKeyRecordStructure.
Parameters
properties?
Properties to set
Returns
Properties
id?
optionalid:null|number
Defined in: WAProto/index.d.ts:36892
PreKeyRecordStructure id.
Implementation of
privateKey?
optionalprivateKey:null|Uint8Array<ArrayBufferLike>
Defined in: WAProto/index.d.ts:36898
PreKeyRecordStructure privateKey.
Implementation of
IPreKeyRecordStructure.privateKey
publicKey?
optionalpublicKey:null|Uint8Array<ArrayBufferLike>
Defined in: WAProto/index.d.ts:36895
PreKeyRecordStructure publicKey.
Implementation of
IPreKeyRecordStructure.publicKey
Methods
toJSON()
toJSON():
object
Defined in: WAProto/index.d.ts:36968
Converts this PreKeyRecordStructure to JSON.
Returns
object
JSON object
create()
staticcreate(properties?):PreKeyRecordStructure
Defined in: WAProto/index.d.ts:36905
Creates a new PreKeyRecordStructure instance using the specified properties.
Parameters
properties?
Properties to set
Returns
PreKeyRecordStructure instance
decode()
staticdecode(reader,length?):PreKeyRecordStructure
Defined in: WAProto/index.d.ts:36931
Decodes a PreKeyRecordStructure 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
PreKeyRecordStructure
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):PreKeyRecordStructure
Defined in: WAProto/index.d.ts:36940
Decodes a PreKeyRecordStructure message from the specified reader or buffer, length delimited.
Parameters
reader
Reader or buffer to decode from
Uint8Array<ArrayBufferLike> | Reader
Returns
PreKeyRecordStructure
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:36913
Encodes the specified PreKeyRecordStructure message. Does not implicitly verify messages.
Parameters
message
PreKeyRecordStructure 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:36921
Encodes the specified PreKeyRecordStructure message, length delimited. Does not implicitly verify messages.
Parameters
message
PreKeyRecordStructure message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):PreKeyRecordStructure
Defined in: WAProto/index.d.ts:36954
Creates a PreKeyRecordStructure message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
PreKeyRecordStructure
getTypeUrl()
staticgetTypeUrl(typeUrlPrefix?):string
Defined in: WAProto/index.d.ts:36975
Gets the default type url for PreKeyRecordStructure
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:36962
Creates a plain object from a PreKeyRecordStructure message. Also converts values to other types if specified.
Parameters
message
PreKeyRecordStructure
options?
IConversionOptions
Conversion options
Returns
object
Plain object
verify()
staticverify(message):null|string
Defined in: WAProto/index.d.ts:36947
Verifies a PreKeyRecordStructure message.
Parameters
message
Plain object to verify
Returns
null | string
null if valid, otherwise the reason why it is not