aboutsummaryrefslogtreecommitdiff
path: root/spec
diff options
context:
space:
mode:
authorMarja Hassinen <ext-marja.2.hassinen@nokia.com>2009-04-23 09:40:30 +0300
committerMarja Hassinen <ext-marja.2.hassinen@nokia.com>2009-04-23 09:40:30 +0300
commitce7cf334268ed42eaf1f8c84c76745b30103b489 (patch)
treeb4f18499a3fcbb76b12e4ba29159763d63e9d292 /spec
parent8378cde5dd049264ed1330ddf52275d754b88f68 (diff)
Adding documentation for the first 3 properties: ChargePercentage, OnBattery, LowBattery.
Diffstat (limited to 'spec')
-rw-r--r--spec/context.xml27
1 files changed, 27 insertions, 0 deletions
diff --git a/spec/context.xml b/spec/context.xml
index f1853b7f..bd02dc5e 100644
--- a/spec/context.xml
+++ b/spec/context.xml
@@ -98,6 +98,33 @@ string.
</doc>
</key>
</node>
+ <node name="Battery">
+ <doc>
+Battery
+-------
+
+Information about the batteries of the device.
+ </doc>
+ <key name="ChargePercentage" type="INT">
+ <doc>
+The average charge level of the currently connected batteries.
+Expressed as percentage of the maximum charge level.
+ </doc>
+ </key>
+ <key name="OnBattery" type="TRUTH">
+ <doc>
+Whether or not the device is currently running on battery power,
+i.e., whether at least one of its batteries is currently discharging.
+ </doc>
+ </key>
+ <key name="LowBattery" type="TRUTH">
+ <doc>
+Whether or not the device is currently running on low battery power.
+True if OnBattery is true and the charge levels of all
+batteries are below 10%.
+ </doc>
+ </key>
+ </node>
<node name="Connectivity">
<doc>
Network connectivity