summaryrefslogtreecommitdiff
path: root/doc/service-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2009-06-28 09:31:47 +0200
committerMarcel Holtmann <marcel@holtmann.org>2009-06-28 09:31:47 +0200
commit345516b13b5b83f428553eb56fd2dcac87a70b3c (patch)
tree53cdc4bea3eb57f0198c26211ccbdb207dd30317 /doc/service-api.txt
parent37eb08572b0384fce26dd6a1467bde727059a084 (diff)
downloadconnman-345516b13b5b83f428553eb56fd2dcac87a70b3c.tar.gz
connman-345516b13b5b83f428553eb56fd2dcac87a70b3c.tar.bz2
connman-345516b13b5b83f428553eb56fd2dcac87a70b3c.zip
Add documentation for the new service error property
Diffstat (limited to 'doc/service-api.txt')
-rw-r--r--doc/service-api.txt17
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/service-api.txt b/doc/service-api.txt
index ab1aa340..8673bc55 100644
--- a/doc/service-api.txt
+++ b/doc/service-api.txt
@@ -84,6 +84,21 @@ Properties string State [readonly]
Valid states are "idle", "failure", "association",
"configuration" and "ready".
+ string Error [readonly]
+
+ The service error status details.
+
+ When error occur during connection or disconnection
+ the detailed information are represented in this
+ property to help the user interface to present the
+ user with alternate options.
+
+ This property is only valid when the service is in
+ the "failure" state. Otherwise it might be empty or
+ not present at all.
+
+ The detailed error codes will be defined later.
+
string Name [readonly]
The service name (for example "Wireless" etc.)
@@ -91,7 +106,7 @@ Properties string State [readonly]
This name can be used for directly displaying it in
the application. It has pure informational purpose.
- For Ethernet devices and hidden WiFi networks it is
+ For Ethernet devices and hidden WiFi networks it is
not guaranteed that this property is present.
string Type [readonly]