From 5be5ec17635762cc22ac96f6f0f5ee86fbfaa31e Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Fri, 30 May 2008 13:25:40 +0000 Subject: Document method callbacks for Simple Pairing --- doc/agent-api.txt | 39 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 36 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/agent-api.txt b/doc/agent-api.txt index febdcd35..d0137aad 100644 --- a/doc/agent-api.txt +++ b/doc/agent-api.txt @@ -20,11 +20,44 @@ Methods void Release() agent, because when this method gets called it has already been unregistered. - string RequestPasskey(object device) + string RequestPinCode(object device) This method gets called when the service daemon - needs to get the passkey for an authentication. The - return value is actual passkey. + needs to get the passkey for an authentication. + + The return value should be a string of 1-16 characters + length. The string can be alphanumeric. + + Possible errors: org.bluez.Error.Rejected + org.bluez.Error.Canceled + + uint32 RequestPasskey(object device) + + This method gets called when the service daemon + needs to get the passkey for an authentication. + + The return value should be a numeric value + between 0-999999. + + Possible errors: org.bluez.Error.Rejected + org.bluez.Error.Canceled + + void DisplayPasskey(object device, uint32 passkey) + + This method gets called when the service daemon + needs to display a passkey for an authentication. + + An empty reply should be returned. When the passkey + needs no longer to be displayed, the Cancel method + of the agent will be called. + + void RequestConfirmation(object device, uint32 passkey) + + This method gets called when the service daemon + needs to confirm a passkey for an authentication. + + To confirm the value it should return an empty reply + or an error in case the passkey is invalid. Possible errors: org.bluez.Error.Rejected org.bluez.Error.Canceled -- cgit