diff options
| author | Luiz Augusto von Dentz <luiz.dentz@indt.org.br> | 2008-09-03 19:31:10 -0300 |
|---|---|---|
| committer | Luiz Augusto von Dentz <luiz.dentz@indt.org.br> | 2008-09-04 10:05:58 -0300 |
| commit | 531fe8fae7f46a86ec850748ffd44ffa754014bd (patch) | |
| tree | f69173c150ad7e061b0477bdea5a283f1865254c /doc | |
| parent | 01761bea1ce6539b97640123660c67d81c54318b (diff) | |
Rename DiscoverDevices to StartDiscovery, CancelDiscovery to StopDiscovery and fix logic around Discovering property to reflect when the base band is busy.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/adapter-api.txt | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt index 4a915d7f..a97ee921 100644 --- a/doc/adapter-api.txt +++ b/doc/adapter-api.txt @@ -54,31 +54,31 @@ Methods dict GetProperties() Possible Errors: org.bluez.Error.DoesNotExist - void DiscoverDevices() + void StartDiscovery() - This method starts the device discovery procedure. This + This method starts the device discovery session. This includes an inquiry procedure and remote device name - resolving. + resolving. Use StopDiscovery to release the sessions + acquired. - On start up this process will generate a DiscoveryStarted - signal and then return DeviceFound singals. If the - procedure has been finished an DiscoveryCompleted - signal will be sent. + This process will start emitting DeviceFound and + PropertyChanged "Discovering" signals. Possible errors: org.bluez.Error.NotReady org.bluez.Error.Failed - org.bluez.Error.InProgress - org.bluez.Error.NoSuchAdapter - void CancelDiscovery() + void StopDiscovery() - This method will cancel any previous DiscoverDevices + This method will cancel any previous StartDiscovery transaction. + Note that a discovery procedure is shared between all + discovery sessions thus calling StopDiscovery will only + release a single session. + Possible errors: org.bluez.Error.NotReady org.bluez.Error.Failed org.bluez.Error.NotAuthorized - org.bluez.Error.NoSuchAdapter object FindDevice(string address) |