diff mbox series

[BlueZ,2/2] org.bluez.Adapter: Add documentation for the Connectable property.

Message ID 20240911145114.103340-3-vibhavp@gmail.com
State New
Headers show
Series adapter: Add (readwrite) Connectable property. | expand

Commit Message

Vibhav Pant Sept. 11, 2024, 2:51 p.m. UTC
---
 doc/org.bluez.Adapter.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)
diff mbox series

Patch

diff --git a/doc/org.bluez.Adapter.rst b/doc/org.bluez.Adapter.rst
index f53728123..3f5fdc8fe 100644
--- a/doc/org.bluez.Adapter.rst
+++ b/doc/org.bluez.Adapter.rst
@@ -283,6 +283,19 @@  uint32 Class [readonly]
 	This property represents the value that is either automatically
 	configured by DMI/ACPI information or provided as static configuration.
 
+boolean Connectable [readwrite]
+```````````````````````````````
+
+	Set an adapter to connectable or non-connectable. This is a global
+	setting and should only be used by the settings application.
+
+	Setting this property to false will set the Discoverable property
+	of the adapter to false as well, which will not be reverted if
+	if Connectable is set back to true. If required, the application
+	will need to manually set Discoverable to true.
+
+	Note that this property only affects incoming connections.
+
 boolean Powered [readwrite]
 ```````````````````````````