Class: PairingRequest
Defined in: WAProto/index.d.ts:35090
Represents a PairingRequest.
Implements
Constructors
new PairingRequest()
new PairingRequest(
properties?):PairingRequest
Defined in: WAProto/index.d.ts:35096
Constructs a new PairingRequest.
Parameters
properties?
Properties to set
Returns
Properties
advSecret?
optionaladvSecret:null|Uint8Array<ArrayBufferLike>
Defined in: WAProto/index.d.ts:35105
PairingRequest advSecret.
Implementation of
companionIdentityKey?
optionalcompanionIdentityKey:null|Uint8Array<ArrayBufferLike>
Defined in: WAProto/index.d.ts:35102
PairingRequest companionIdentityKey.
Implementation of
IPairingRequest.companionIdentityKey
companionPublicKey?
optionalcompanionPublicKey:null|Uint8Array<ArrayBufferLike>
Defined in: WAProto/index.d.ts:35099
PairingRequest companionPublicKey.
Implementation of
IPairingRequest.companionPublicKey
Methods
toJSON()
toJSON():
object
Defined in: WAProto/index.d.ts:35175
Converts this PairingRequest to JSON.
Returns
object
JSON object
create()
staticcreate(properties?):PairingRequest
Defined in: WAProto/index.d.ts:35112
Creates a new PairingRequest instance using the specified properties.
Parameters
properties?
Properties to set
Returns
PairingRequest instance
decode()
staticdecode(reader,length?):PairingRequest
Defined in: WAProto/index.d.ts:35138
Decodes a PairingRequest 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
PairingRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):PairingRequest
Defined in: WAProto/index.d.ts:35147
Decodes a PairingRequest message from the specified reader or buffer, length delimited.
Parameters
reader
Reader or buffer to decode from
Uint8Array<ArrayBufferLike> | Reader
Returns
PairingRequest
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:35120
Encodes the specified PairingRequest message. Does not implicitly verify messages.
Parameters
message
PairingRequest 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:35128
Encodes the specified PairingRequest message, length delimited. Does not implicitly verify messages.
Parameters
message
PairingRequest message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):PairingRequest
Defined in: WAProto/index.d.ts:35161
Creates a PairingRequest message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
PairingRequest
getTypeUrl()
staticgetTypeUrl(typeUrlPrefix?):string
Defined in: WAProto/index.d.ts:35182
Gets the default type url for PairingRequest
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:35169
Creates a plain object from a PairingRequest message. Also converts values to other types if specified.
Parameters
message
PairingRequest
options?
IConversionOptions
Conversion options
Returns
object
Plain object
verify()
staticverify(message):null|string
Defined in: WAProto/index.d.ts:35154
Verifies a PairingRequest message.
Parameters
message
Plain object to verify
Returns
null | string
null if valid, otherwise the reason why it is not