System information is represented as system attributes. Each system
attribute consists of an entity and a key. The entity broadly
represents a device component or feature, such as battery or connectivity.
The key is an attribute of the entity. Entities can have multiple keys, with
each entity-key pair representing a single system attribute. For example,
battery strength and charging status are attributes of battery. The system
attributes for these are Battery - BatteryStrength
and Battery
- ChargingStatus
, respectively (see Table:
Battery system attributes). Each system attribute has a value that
contains data about the attribute. For some system attributes, the value can
be modified.
For more information about the supported system attributes, see section Supported system attributes (entities and keys).
For more information about the system data types that determine system attribute values, see section System data types.
In JavaScript, a system attribute is represented as an object, with the entity, key, and value as properties of that object:
Property |
Description |
Type |
Value |
---|---|---|---|
|
Specifies the entity of the system attribute. Together with |
string |
For a complete list of supported entities, see section Supported system attributes (entities and keys). |
|
Specifies the key of the system attribute. The available keys depend on the entity. Together with |
string |
For a complete list of supported keys per entity, see the Key column of the tables in section Supported system attributes (entities and keys). |
< |
Specifies the value of the system attribute. The name, type, and content of this property depend on the system attribute and whether the system attribute object is used as input or output: INPUT If the system attribute object is used as input for a method call, this
property is an object named For example: If you input the
Here, Similarly, if you input the
OUTPUT If the system attribute object is received as output from a method call,
the system attribute value is represented as one or more properties of the For example: If the
Here, Similarly, if the
|
See the Input and Output columns of the tables in section Supported system attributes (entities and keys). |