diff options
author | Scott James Remnant <scott@netsplit.com> | 2012-04-05 15:29:39 -0700 |
---|---|---|
committer | Johan Hedberg <johan.hedberg@intel.com> | 2012-04-12 14:10:50 +0300 |
commit | c8207bce0169af1149670627e7b6f46e847315f9 (patch) | |
tree | 45c81c547eff298fb159ec4ebec7ad01c735b1eb /doc/agent-api.txt | |
parent | a3b3fc40021f9ff1cacdb54889ac1d98f614f45d (diff) | |
download | bluez-c8207bce0169af1149670627e7b6f46e847315f9.tar.gz |
doc: document DisplayPinCode
Diffstat (limited to 'doc/agent-api.txt')
-rw-r--r-- | doc/agent-api.txt | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/agent-api.txt b/doc/agent-api.txt index 9ab2063b4..5c8d4d2fa 100644 --- a/doc/agent-api.txt +++ b/doc/agent-api.txt @@ -61,6 +61,30 @@ 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 |