Class: DeviceProps
Defined in: WAProto/index.d.ts:11779
Represents a DeviceProps.
Implements
Constructors
new DeviceProps()
new DeviceProps(
properties
?):DeviceProps
Defined in: WAProto/index.d.ts:11785
Constructs a new DeviceProps.
Parameters
properties?
Properties to set
Returns
Properties
historySyncConfig?
optional
historySyncConfig:null
|IHistorySyncConfig
Defined in: WAProto/index.d.ts:11800
DeviceProps historySyncConfig.
Implementation of
IDeviceProps
.historySyncConfig
os?
optional
os:null
|string
Defined in: WAProto/index.d.ts:11788
DeviceProps os.
Implementation of
platformType?
optional
platformType:null
|PlatformType
Defined in: WAProto/index.d.ts:11794
DeviceProps platformType.
Implementation of
requireFullSync?
optional
requireFullSync:null
|boolean
Defined in: WAProto/index.d.ts:11797
DeviceProps requireFullSync.
Implementation of
version?
optional
version:null
|IAppVersion
Defined in: WAProto/index.d.ts:11791
DeviceProps version.
Implementation of
Methods
toJSON()
toJSON():
object
Defined in: WAProto/index.d.ts:11870
Converts this DeviceProps to JSON.
Returns
object
JSON object
create()
static
create(properties
?):DeviceProps
Defined in: WAProto/index.d.ts:11807
Creates a new DeviceProps instance using the specified properties.
Parameters
properties?
Properties to set
Returns
DeviceProps instance
decode()
static
decode(reader
,length
?):DeviceProps
Defined in: WAProto/index.d.ts:11833
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()
static
decodeDelimited(reader
):DeviceProps
Defined in: WAProto/index.d.ts:11842
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()
static
encode(message
,writer
?):Writer
Defined in: WAProto/index.d.ts:11815
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()
static
encodeDelimited(message
,writer
?):Writer
Defined in: WAProto/index.d.ts:11823
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()
static
fromObject(object
):DeviceProps
Defined in: WAProto/index.d.ts:11856
Creates a DeviceProps message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
DeviceProps
getTypeUrl()
static
getTypeUrl(typeUrlPrefix
?):string
Defined in: WAProto/index.d.ts:11877
Gets the default type url for DeviceProps
Parameters
typeUrlPrefix?
string
your custom typeUrlPrefix(default "type.googleapis.com")
Returns
string
The default type url
toObject()
static
toObject(message
,options
?):object
Defined in: WAProto/index.d.ts:11864
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()
static
verify(message
):null
|string
Defined in: WAProto/index.d.ts:11849
Verifies a DeviceProps message.
Parameters
message
Plain object to verify
Returns
null
| string
null
if valid, otherwise the reason why it is not