summaryrefslogtreecommitdiffstats
path: root/doc/adapter-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2008-03-13 19:28:32 +0000
committerMarcel Holtmann <marcel@holtmann.org>2008-03-13 19:28:32 +0000
commitfc8eb9740a846de0724f5580afb3b08bcda1bc1e (patch)
treef691ee329f9ebb3617d7954883f58823de7089fc /doc/adapter-api.txt
parentb573eca995bacaf8c901c5d90f55ad5cbe273819 (diff)
Document agent register/unregister methods
Diffstat (limited to 'doc/adapter-api.txt')
-rw-r--r--doc/adapter-api.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index 259e7018..305aa624 100644
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@@ -112,6 +112,26 @@ Methods dict GetProperties()
Possible errors: org.bluez.Error.InvalidArguments
org.bluez.Error.Failed
+ void RegisterAgent(object agent)
+
+ This registers the adapter wide agent.
+
+ The object path defines the path the of the agent
+ that will be called when user input is needed.
+
+ If an application disconnects from the bus all
+ of its registered agents will be removed.
+
+ Possible errors: org.bluez.Error.AlreadyExists
+
+ void UnregisterAgent(object agent)
+
+ This unregisters the agent that has been previously
+ registered. The object path parameter must match the
+ same value that has been used on registration.
+
+ Possible errors: org.bluez.Error.DoesNotExist
+
Signals PropertyChanged(string name, variant value)
This signal indicates a changed value of the given