diff options
| author | Johan Hedberg <johan.hedberg@intel.com> | 2012-10-17 10:42:41 +0300 |
|---|---|---|
| committer | Johan Hedberg <johan.hedberg@intel.com> | 2012-10-17 10:43:53 +0300 |
| commit | 9b80a1f0632998b424d20c319761326e95796096 (patch) | |
| tree | fa5780c9c4e1456166a5cab1b7340bdcf5a28594 /doc/adapter-api.txt | |
| parent | 03cd7b4b91ac97803c2b8516f13bb8d48a93f211 (diff) | |
| download | bluez-9b80a1f0632998b424d20c319761326e95796096.tar.gz | |
doc: Update to match latest BlueZ 5 API
Diffstat (limited to 'doc/adapter-api.txt')
| -rw-r--r-- | doc/adapter-api.txt | 32 |
1 files changed, 6 insertions, 26 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt index a72e9df76..b63858656 100644 --- a/doc/adapter-api.txt +++ b/doc/adapter-api.txt @@ -14,22 +14,7 @@ Service org.bluez Interface org.bluez.Adapter Object path [variable prefix]/{hci0,hci1,...} -Methods dict GetProperties() - - Returns all properties for the adapter. See the - properties section for available properties. - - Possible Errors: org.bluez.Error.NotReady - - void SetProperty(string name, variant value) - - Changes the value of the specified property. Only - properties that are listed as read-write are changeable. - On success this will emit a PropertyChanged signal. - - Possible Errors: org.bluez.Error.InvalidArguments - - void RequestSession() +Methods void RequestSession() This method requests a client session that provides operational Bluetooth. A possible mode change must be @@ -47,9 +32,9 @@ Methods dict GetProperties() 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. + Setting the powered or discoverable properties + changes adapter's mode persistently, such that session + release will not modify it. Possible Errors: org.bluez.Error.DoesNotExist @@ -60,7 +45,7 @@ Methods dict GetProperties() resolving. Use StopDiscovery to release the sessions acquired. - This process will start emitting DeviceFound and + This process will start emitting DevicesFound and PropertyChanged "Discovering" signals. Possible errors: org.bluez.Error.NotReady @@ -122,12 +107,7 @@ Methods dict GetProperties() Possible errors: org.bluez.Error.DoesNotExist -Signals PropertyChanged(string name, variant value) - - This signal indicates a changed value of the given - property. - - DevicesFound(array{object path, dict values}) +Signals DevicesFound(array{object path, dict values}) This signal will be sent every time devices have been found. In general they only appear during a |