summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2008-03-14 20:09:33 +0000
committerMarcel Holtmann <marcel@holtmann.org>2008-03-14 20:09:33 +0000
commitf2e721cb33943a434fc4a1565badc774b3397e93 (patch)
treee11dd847d43e7baafda2c902cda7600212193689 /doc
parentfbf89763779b6ebad6ed956d8c81bfdeb8317122 (diff)
Document the RequestMode method
Diffstat (limited to 'doc')
-rw-r--r--doc/adapter-api.txt17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index 0d8011f2..1f28988e 100644
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@@ -31,6 +31,23 @@ Methods dict GetProperties()
Possible Errors: org.bluez.Error.DoesNotExist
org.bluez.Error.InvalidArguments
+ void RequestMode(string mode)
+
+ This method will request a mode change. The mode
+ change must be confirmed by the user via the agent.
+
+ Possible modes for this call are "connectable" and
+ "discoverable". Any application that wants to use
+ Bluetooth functionality can use this method to
+ indicate which mode it needs to operate sucessfully.
+
+ In case the user doesn't confirm the mode change it
+ will return an error to indicate this rejection.
+
+ Possible Errors: org.bluez.Error.DoesNotExist
+ org.bluez.Error.InvalidArguments
+ org.bluez.Error.Rejected
+
void DiscoverDevices()
This method starts the device discovery procedure. This