summaryrefslogtreecommitdiff
path: root/doc/agent-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2012-12-19 18:00:25 +0100
committerMarcel Holtmann <marcel@holtmann.org>2012-12-19 18:01:27 +0100
commit74e1e34174d64c302b60d37794af349a147df22b (patch)
tree400c8d24d1ab1958fbd23dcbdc9fc9106fa84180 /doc/agent-api.txt
parentc7c9de0ed945cef132ee73fc30f5709fadc9dd98 (diff)
downloadbluez-74e1e34174d64c302b60d37794af349a147df22b.tar.gz
doc: Move DisplayPinCode section to the right location
Diffstat (limited to 'doc/agent-api.txt')
-rw-r--r--doc/agent-api.txt51
1 files changed, 27 insertions, 24 deletions
diff --git a/doc/agent-api.txt b/doc/agent-api.txt
index 33a877c7f..93b693101 100644
--- a/doc/agent-api.txt
+++ b/doc/agent-api.txt
@@ -91,6 +91,33 @@ Methods void Release()
Possible errors: org.bluez.Error.Rejected
org.bluez.Error.Canceled
+ void DisplayPinCode(object device, string pincode)
+
+ This method gets called when the service daemon
+ needs to display a pincode for an authentication.
+
+ An empty reply should be returned. When the pincode
+ needs no longer to be displayed, the Cancel method
+ of the agent will be called.
+
+ If this method is not implemented the RequestPinCode
+ method will be used instead.
+
+ This is used during the pairing process of keyboards
+ that don't support Bluetooth 2.1 Secure Simple Pairing,
+ in contrast to DisplayPasskey which is used for those
+ that do.
+
+ This method will only ever be called once since
+ older keyboards do not support typing notification.
+
+ Note that the PIN will always be a 6-digit number,
+ zero-padded to 6 digits. This is for harmony with
+ the later specification.
+
+ Possible errors: org.bluez.Error.Rejected
+ org.bluez.Error.Canceled
+
uint32 RequestPasskey(object device)
This method gets called when the service daemon
@@ -122,30 +149,6 @@ Methods void Release()
so the display should be zero-padded at the start if
the value contains less than 6 digits.
- void DisplayPinCode(object device, string pincode)
-
- This method gets called when the service daemon
- needs to display a pincode for an authentication.
-
- An empty reply should be returned. When the pincode
- needs no longer to be displayed, the Cancel method
- of the agent will be called.
-
- If this method is not implemented the RequestPinCode
- method will be used instead.
-
- This is used during the pairing process of keyboards
- that don't support Bluetooth 2.1 Secure Simple Pairing,
- in contrast to DisplayPasskey which is used for those
- that do.
-
- This method will only ever be called once since
- older keyboards do not support typing notification.
-
- Note that the PIN will always be a 6-digit number,
- zero-padded to 6 digits. This is for harmony with
- the later specification.
-
void RequestConfirmation(object device, uint32 passkey)
This method gets called when the service daemon