summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZhengping Jiang <jiangzp@google.com>2022-05-04 14:09:47 -0700
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2022-05-04 14:56:01 -0700
commit5c05df7c7607d18aa1dc115eca1ea6c08668c85e (patch)
tree9845c2bedb52ee0901547443c970b93500fb3cc0 /doc
parentb7ca43eedfd5a028909a410287ad915ec026e24d (diff)
downloadbluez-5c05df7c7607d18aa1dc115eca1ea6c08668c85e.tar.gz
doc: add "Bonded" flag to dbus property
Bonded flag is used to indicate the link key or ltk of the remote device has been stored. Reviewed-by: Sonny Sasaka <sonnysasaka@chromium.org> Reviewed-by: Yun-Hao Chung <howardchung@chromium.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/device-api.txt12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/device-api.txt b/doc/device-api.txt
index 4e824d2de..6a9066440 100644
--- a/doc/device-api.txt
+++ b/doc/device-api.txt
@@ -169,7 +169,17 @@ Properties string Address [readonly]
boolean Paired [readonly]
- Indicates if the remote device is paired.
+ Indicates if the remote device is paired. Pairing is
+ the process where devices exchange the information to
+ establish an encrypted connection.
+
+ 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.
boolean Connected [readonly]