summaryrefslogtreecommitdiffstats
path: root/doc/adapter-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2008-09-23 21:34:46 +0200
committerMarcel Holtmann <marcel@holtmann.org>2008-09-23 21:34:46 +0200
commitcd679653f41c930d701aa57da4d3440cc3485fbd (patch)
tree7fdf90479edb4a27ba4517e246c1492114ad9999 /doc/adapter-api.txt
parent54a7a2f4e5a5cae1bef9f8edbcb4650e3d835c9f (diff)
Document mode handling changes
Diffstat (limited to 'doc/adapter-api.txt')
-rw-r--r--doc/adapter-api.txt42
1 files changed, 39 insertions, 3 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index 0ded04d1..59262814 100644
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@@ -31,7 +31,7 @@ Methods dict GetProperties()
Possible Errors: org.bluez.Error.DoesNotExist
org.bluez.Error.InvalidArguments
- void RequestMode(string mode)
+ void RequestMode(string mode) {deprecated}
This method will request a mode change. The mode
change must be confirmed by the user via the agent.
@@ -48,12 +48,26 @@ Methods dict GetProperties()
org.bluez.Error.InvalidArguments
org.bluez.Error.Rejected
- void ReleaseMode()
+ void ReleaseMode() {deprecated}
Releases a mode requested via RequestMode.
Possible Errors: org.bluez.Error.DoesNotExist
+ void RequestSession()
+
+ This method will request a client session that
+ provides operational Bluetooth. A possible mode
+ change must be confirmed by the user via the agent.
+
+ Possible Errors: org.bluez.Error.Rejected
+
+ void ReleaseSession{}
+
+ Release a previous requested session.
+
+ Possible Errors: org.bluez.Error.DoesNotExist
+
void StartDiscovery()
This method starts the device discovery session. This
@@ -205,13 +219,35 @@ Properties string Address [readonly]
The Bluetooth friendly name. This value can be
changed and a PropertyChanged signal will be emitted.
- string Mode [readwrite]
+ string Mode [readwrite] {deprecated}
The Bluetooth operation mode.
Valid modes: "off", "connectable",
"discoverable", "limited"
+ This is deprecated by the Powered and Discoverable
+ properties.
+
+ boolean Powered [readwrite]
+
+ Switch an adapter on or off. This will also set the
+ appropiate connectable state.
+
+ boolean Discoverable [readwrite]
+
+ Switch an adapter to discoverable or non-discoverable
+ to either make it visible or hide it. This is a global
+ setting and should only be used by the settings
+ application.
+
+ If the DiscoverableTimeout is set to a non-zero
+ value then the system will set this value back to
+ false after the timer expired.
+
+ In case the adapter is switched off, setting this
+ value will fail.
+
uint32 DiscoverableTimeout [readwrite]
The discoverable timeout in seconds. A value of zero