Class: DeviceProps
Defined in: WAProto/index.d.ts:13202
Represents a DeviceProps.
Implements
Constructors
new DeviceProps()
new DeviceProps(
properties?):DeviceProps
Defined in: WAProto/index.d.ts:13208
Constructs a new DeviceProps.
Parameters
properties?
Properties to set
Returns
Properties
historySyncConfig?
optionalhistorySyncConfig:null|IHistorySyncConfig
Defined in: WAProto/index.d.ts:13223
DeviceProps historySyncConfig.
Implementation of
IDeviceProps.historySyncConfig
os?
optionalos:null|string
Defined in: WAProto/index.d.ts:13211
DeviceProps os.
Implementation of
platformType?
optionalplatformType:null|PlatformType
Defined in: WAProto/index.d.ts:13217
DeviceProps platformType.
Implementation of
requireFullSync?
optionalrequireFullSync:null|boolean
Defined in: WAProto/index.d.ts:13220
DeviceProps requireFullSync.
Implementation of
version?
optionalversion:null|IAppVersion
Defined in: WAProto/index.d.ts:13214
DeviceProps version.
Implementation of
Methods
toJSON()
toJSON():
object
Defined in: WAProto/index.d.ts:13293
Converts this DeviceProps to JSON.
Returns
object
JSON object
create()
staticcreate(properties?):DeviceProps
Defined in: WAProto/index.d.ts:13230
Creates a new DeviceProps instance using the specified properties.
Parameters
properties?
Properties to set
Returns
DeviceProps instance
decode()
staticdecode(reader,length?):DeviceProps
Defined in: WAProto/index.d.ts:13256
Decodes a DeviceProps 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
DeviceProps
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):DeviceProps
Defined in: WAProto/index.d.ts:13265
Decodes a DeviceProps message from the specified reader or buffer, length delimited.
Parameters
reader
Reader or buffer to decode from
Uint8Array<ArrayBufferLike> | Reader
Returns
DeviceProps
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:13238
Encodes the specified DeviceProps message. Does not implicitly verify messages.
Parameters
message
DeviceProps 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:13246
Encodes the specified DeviceProps message, length delimited. Does not implicitly verify messages.
Parameters
message
DeviceProps message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):DeviceProps
Defined in: WAProto/index.d.ts:13279
Creates a DeviceProps message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
DeviceProps
getTypeUrl()
staticgetTypeUrl(typeUrlPrefix?):string
Defined in: WAProto/index.d.ts:13300
Gets the default type url for DeviceProps
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:13287
Creates a plain object from a DeviceProps message. Also converts values to other types if specified.
Parameters
message
DeviceProps
options?
IConversionOptions
Conversion options
Returns
object
Plain object
verify()
staticverify(message):null|string
Defined in: WAProto/index.d.ts:13272
Verifies a DeviceProps message.
Parameters
message
Plain object to verify
Returns
null | string
null if valid, otherwise the reason why it is not