summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2008-12-01 17:48:32 +0100
committerMarcel Holtmann <marcel@holtmann.org>2008-12-01 17:48:32 +0100
commite37783a59efb9abf66bdfe9f075714c72f421886 (patch)
tree3191c59c05436b49e6d09a6548d2cb79927b3f8d
parent75648ce6edd38a4ae1cc6e2a7ea4684a018abd89 (diff)
Add documentation for global manager properties
-rw-r--r--doc/manager-api.txt21
1 files changed, 19 insertions, 2 deletions
diff --git a/doc/manager-api.txt b/doc/manager-api.txt
index 851edd9b..e045cad2 100644
--- a/doc/manager-api.txt
+++ b/doc/manager-api.txt
@@ -14,7 +14,15 @@ Service org.bluez
Interface org.bluez.Manager
Object path /
-Methods object DefaultAdapter()
+Methods dict GetProperties()
+
+ Returns all global properties. See the
+ properties section for available properties.
+
+ Possible Errors: org.bluez.Error.DoesNotExist
+ org.bluez.Error.InvalidArguments
+
+ object DefaultAdapter()
Returns object path for the default adapter.
@@ -37,7 +45,12 @@ Methods object DefaultAdapter()
org.bluez.Error.Failed
org.bluez.Error.OutOfMemory
-Signals AdapterAdded(object adapter)
+Signals PropertyChanged(string name, variant value)
+
+ This signal indicates a changed value of the given
+ property.
+
+ AdapterAdded(object adapter)
Parameter is object path of added adapter.
@@ -53,3 +66,7 @@ Signals AdapterAdded(object adapter)
be emitted. The AdapterRemoved signal has to be used
to detect that no default adapter is selected or
available anymore.
+
+Properties array{object} Adapters [readonly]
+
+ List of adapter object paths.