diff mbox series

[BlueZ,2/2] org.bluez.Device: Add documentation for GetServiceRecords()

Message ID 20240907213301.14000-3-vibhavp@gmail.com (mailing list archive)
State Accepted
Commit 44a1930479b70d531b00b88a21a5b11cb732886f
Headers show
Series org.bluez.Device1: Add GetServiceRecords method to get a device's SDP records. | expand

Checks

Context Check Description
tedd_an/pre-ci_am success Success
tedd_an/CheckPatch success CheckPatch PASS
tedd_an/GitLint success Gitlint PASS
tedd_an/IncrementalBuild success Incremental Build PASS

Commit Message

Vibhav Pant Sept. 7, 2024, 9:33 p.m. UTC
---
 doc/org.bluez.Device.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
diff mbox series

Patch

diff --git a/doc/org.bluez.Device.rst b/doc/org.bluez.Device.rst
index f94fc2129..f8d4a68a6 100644
--- a/doc/org.bluez.Device.rst
+++ b/doc/org.bluez.Device.rst
@@ -135,6 +135,25 @@  void CancelPairing()
 	:org.bluez.Error.DoesNotExist:
 	:org.bluez.Error.Failed:
 
+array{array{byte}} GetServiceRecords() [experimental]
+`````````````````````````````````````````````````````
+
+	Returns all currently known BR/EDR service records for the device. Each
+	individual byte array represents a raw SDP record, as defined by the
+	Bluetooth Service Discovery Protocol specification.
+
+	This method is intended to be only used by compatibility layers like
+	Wine, that need to provide access to raw SDP records to support foreign
+	Bluetooth APIs. General applications should instead use the Profile API
+	for services-related functionality.
+
+	Possible errors:
+
+	:org.bluez.Error.Failed:
+	:org.bluez.Error.NotReady:
+	:org.bluez.Error.NotConnected:
+	:org.bluez.Error.DoesNotExist:
+
 Properties
 ----------