diff options
| author | Dmitriy Paliy <dmitriy.paliy@nokia.com> | 2011-03-28 17:21:56 +0300 |
|---|---|---|
| committer | Johan Hedberg <johan.hedberg@nokia.com> | 2011-03-28 17:25:39 +0300 |
| commit | 468e11fe311bb8e2eab2b43e44bfa397359443c5 (patch) | |
| tree | 1510a8b07252f1e579c2171d856d6f1fee29ac14 /doc/adapter-api.txt | |
| parent | 2bd4b645a170e0c492fb7664f6a79f16319d88e6 (diff) | |
| download | bluez-468e11fe311bb8e2eab2b43e44bfa397359443c5.tar.gz | |
Update Adapter API documentation
RequestSession and ReleaseSession description is updated in adapter
API.
Diffstat (limited to 'doc/adapter-api.txt')
| -rw-r--r-- | doc/adapter-api.txt | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt index 5272d74d9..f34d58fd8 100644 --- a/doc/adapter-api.txt +++ b/doc/adapter-api.txt @@ -31,15 +31,25 @@ Methods dict GetProperties() 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. + This method requests a client session that provides + operational Bluetooth. A possible mode change must be + confirmed by the user via the agent. + + Clients may request multiple sessions. All sessions + are released when adapter's mode is changed to off + state. Possible Errors: org.bluez.Error.Rejected void ReleaseSession() - Release a previous requested session. + Release a previously requested session. It sets + adapter to the mode in use on the moment of session + request. + + SetProperty method call changes adapter's mode + persistently, such that session release will not + modify it. Possible Errors: org.bluez.Error.DoesNotExist |