diff mbox series

[RFC,v2,1/1] adapter - D-Bus API for querying the adapter's capabilities

Message ID 20200817142137.RFC.v2.1.Ibaa1dfd49179a141c19a651f3c2132a28b71b344@changeid (mailing list archive)
State Accepted
Delegated to: Luiz Von Dentz
Headers show
Series A client needs to query whether the Bluetooth adapter support WBS, so we | expand

Commit Message

Yu Liu Aug. 17, 2020, 9:21 p.m. UTC 
From: Archie Pusaka <apusaka@chromium.org>

Initially this is introduced to query whether WBS is supported by the adapter,
the API is generic enough to be extended to support querying others in
the future.

Reviewed-by: sonnysasaka@chromium.org

Signed-off-by: Yu Liu <yudiliu@google.com>
---

Changes in v2:
- Return an array of strings instead of a dict

Changes in v1:
- Initial change

 doc/adapter-api.txt | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
diff mbox series

Patch

diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index 1a7255750..250d0e9b3 100644
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@@ -204,6 +204,23 @@  Methods		void StartDiscovery()
 					 org.bluez.Error.NotReady
 					 org.bluez.Error.Failed
 
+		dict GetSupportedCapabilities()
+
+			This method returns a dictionary of supported
+			capabilities that is populated when the adapter
+			initiated.
+
+			The dictionary is following the format
+			{capability : value}, where:
+
+			string capability:	The supported capability under
+						discussion.
+			variant value:		A more detailed description of
+						the capability.
+
+			Possible errors: org.bluez.Error.NotReady
+					 org.bluez.Error.Failed
+
 Properties	string Address [readonly]
 
 			The Bluetooth device address.