diff options
| author | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2022-05-04 16:39:30 -0700 |
|---|---|---|
| committer | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2022-05-04 16:39:30 -0700 |
| commit | 7ce093041a19b7195ddab6940e62587edc7b99ea (patch) | |
| tree | e14f9b863038184baa12cba7ade7af8a47d9c4d4 /doc | |
| parent | bda2a9e6f90295f295bd14ec8596bdd263eb0671 (diff) | |
| download | bluez-7ce093041a19b7195ddab6940e62587edc7b99ea.tar.gz | |
device-api: Clarify Paired/Bonded documentation
This attempt to clarify the distinction of Paired and Bonded
properties.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/device-api.txt | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/doc/device-api.txt b/doc/device-api.txt index 6a9066440..628accb8a 100644 --- a/doc/device-api.txt +++ b/doc/device-api.txt @@ -169,17 +169,16 @@ Properties string Address [readonly] boolean Paired [readonly] - Indicates if the remote device is paired. Pairing is - the process where devices exchange the information to - establish an encrypted connection. + Indicates if the remote device is paired. Paired means + the pairing process where devices exchange the + information to establish an encrypted connection has + been completed. boolean Bonded [readonly] Indicates if the remote device is bonded. Bonded means - the link key or the ltk from the pairing process has - been stored. - A PropertiesChanged signal indicate changes to this - status. + the information exchanged on pairing process has been + stored and will be persisted. boolean Connected [readonly] |