doc: add "Bonded" flag to dbus property
authorZhengping Jiang <jiangzp@google.com>
Wed, 4 May 2022 21:09:47 +0000 (14:09 -0700)
committerAyush Garg <ayush.garg@samsung.com>
Mon, 15 May 2023 09:25:54 +0000 (14:55 +0530)
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>
Signed-off-by: Manika Shrivastava <manika.sh@samsung.com>
Signed-off-by: Ayush Garg <ayush.garg@samsung.com>
doc/device-api.txt

index 063dcd7..9a743f9 100644 (file)
@@ -225,7 +225,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.
 
 #ifdef TIZEN_FEATURE_BLUEZ_MODIFY
                byte Connected [readonly]