Class: CompanionEphemeralIdentity
Defined in: WAProto/index.d.ts:9188
Represents a CompanionEphemeralIdentity.
Implements
Constructors
new CompanionEphemeralIdentity()
new CompanionEphemeralIdentity(
properties?):CompanionEphemeralIdentity
Defined in: WAProto/index.d.ts:9194
Constructs a new CompanionEphemeralIdentity.
Parameters
properties?
Properties to set
Returns
Properties
deviceType?
optionaldeviceType:null|PlatformType
Defined in: WAProto/index.d.ts:9200
CompanionEphemeralIdentity deviceType.
Implementation of
ICompanionEphemeralIdentity.deviceType
publicKey?
optionalpublicKey:null|Uint8Array<ArrayBufferLike>
Defined in: WAProto/index.d.ts:9197
CompanionEphemeralIdentity publicKey.
Implementation of
ICompanionEphemeralIdentity.publicKey
ref?
optionalref:null|string
Defined in: WAProto/index.d.ts:9203
CompanionEphemeralIdentity ref.
Implementation of
ICompanionEphemeralIdentity.ref
Methods
toJSON()
toJSON():
object
Defined in: WAProto/index.d.ts:9273
Converts this CompanionEphemeralIdentity to JSON.
Returns
object
JSON object
create()
staticcreate(properties?):CompanionEphemeralIdentity
Defined in: WAProto/index.d.ts:9210
Creates a new CompanionEphemeralIdentity instance using the specified properties.
Parameters
properties?
Properties to set
Returns
CompanionEphemeralIdentity instance
decode()
staticdecode(reader,length?):CompanionEphemeralIdentity
Defined in: WAProto/index.d.ts:9236
Decodes a CompanionEphemeralIdentity 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
CompanionEphemeralIdentity
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):CompanionEphemeralIdentity
Defined in: WAProto/index.d.ts:9245
Decodes a CompanionEphemeralIdentity message from the specified reader or buffer, length delimited.
Parameters
reader
Reader or buffer to decode from
Uint8Array<ArrayBufferLike> | Reader
Returns
CompanionEphemeralIdentity
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:9218
Encodes the specified CompanionEphemeralIdentity message. Does not implicitly verify messages.
Parameters
message
CompanionEphemeralIdentity 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:9226
Encodes the specified CompanionEphemeralIdentity message, length delimited. Does not implicitly verify messages.
Parameters
message
CompanionEphemeralIdentity message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):CompanionEphemeralIdentity
Defined in: WAProto/index.d.ts:9259
Creates a CompanionEphemeralIdentity message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
CompanionEphemeralIdentity
getTypeUrl()
staticgetTypeUrl(typeUrlPrefix?):string
Defined in: WAProto/index.d.ts:9280
Gets the default type url for CompanionEphemeralIdentity
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:9267
Creates a plain object from a CompanionEphemeralIdentity message. Also converts values to other types if specified.
Parameters
message
CompanionEphemeralIdentity
options?
IConversionOptions
Conversion options
Returns
object
Plain object
verify()
staticverify(message):null|string
Defined in: WAProto/index.d.ts:9252
Verifies a CompanionEphemeralIdentity message.
Parameters
message
Plain object to verify
Returns
null | string
null if valid, otherwise the reason why it is not