summaryrefslogtreecommitdiff
path: root/doc/device-api.txt
diff options
context:
space:
mode:
authorJohan Hedberg <johan.hedberg@intel.com>2012-10-09 19:38:07 +0200
committerJohan Hedberg <johan.hedberg@intel.com>2012-10-09 19:38:10 +0200
commit7dae3e94c9e0349a2d4508a0013655d6cbb78f36 (patch)
treeb052e63371274b33dd819e9abf5595ec46d48d82 /doc/device-api.txt
parente90b16a04d6f23742fcad105cb29cf75218d617d (diff)
downloadbluez-7dae3e94c9e0349a2d4508a0013655d6cbb78f36.tar.gz
core: Add initial Device.Pair() implementation
This will ultimately replace Adapter.CreatePairedDevice()
Diffstat (limited to 'doc/device-api.txt')
-rw-r--r--doc/device-api.txt18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/device-api.txt b/doc/device-api.txt
index 71abb2948..104ec176c 100644
--- a/doc/device-api.txt
+++ b/doc/device-api.txt
@@ -106,6 +106,24 @@ Methods dict GetProperties()
Possible errors: org.bluez.Error.DoesNotExist
org.bluez.Error.NotConnected
+ void Pair(object agent, string capability)
+
+ This method will connect to the remote device,
+ initiate pairing and then retrieve all SDP records
+ (or GATT primary services).
+
+ The agent object path is assumed to reside within the
+ process (D-Bus connection instance) that calls this
+ method. No separate registration procedure is needed
+ for it and it gets automatically released once the
+ pairing operation is complete.
+
+ The capability parameter is the same as for the
+ Adapter.RegisterAgent method.
+
+ Possible errors: org.bluez.Error.InvalidArguments
+ org.bluez.Error.Failed
+
Signals PropertyChanged(string name, variant value)
This signal indicates a changed value of the given