1 BlueZ D-Bus Agent API description 2 ********************************** 3 4 Copyright (C) 2004-2010 Marcel Holtmann <marcel (a] holtmann.org> 5 Copyright (C) 2005-2006 Johan Hedberg <johan.hedberg (a] nokia.com> 6 7 8 Agent hierarchy 9 =============== 10 11 Service unique name 12 Interface org.bluez.Agent 13 Object path freely definable 14 15 Methods void Release() 16 17 This method gets called when the service daemon 18 unregisters the agent. An agent can use it to do 19 cleanup tasks. There is no need to unregister the 20 agent, because when this method gets called it has 21 already been unregistered. 22 23 string RequestPinCode(object device) 24 25 This method gets called when the service daemon 26 needs to get the passkey for an authentication. 27 28 The return value should be a string of 1-16 characters 29 length. Longer strings are truncated to 16 characters. 30 The string can be alphanumeric. 31 32 Strings starting with '$' are parsed as hex-encoded 33 pins. That is, each two following hex characters form 34 a single byte of the resulting pin. The parser is 35 case-insensitive. 36 37 Possible errors: org.bluez.Error.Rejected 38 org.bluez.Error.Canceled 39 40 uint32 RequestPasskey(object device) 41 42 This method gets called when the service daemon 43 needs to get the passkey for an authentication. 44 45 The return value should be a numeric value 46 between 0-999999. 47 48 Possible errors: org.bluez.Error.Rejected 49 org.bluez.Error.Canceled 50 51 void DisplayPasskey(object device, uint32 passkey, uint8 entered) 52 53 This method gets called when the service daemon 54 needs to display a passkey for an authentication. 55 56 The entered parameter indicates the number of already 57 typed keys on the remote side. 58 59 An empty reply should be returned. When the passkey 60 needs no longer to be displayed, the Cancel method 61 of the agent will be called. 62 63 During the pairing process this method might be 64 called multiple times to update the entered value. 65 66 void RequestConfirmation(object device, uint32 passkey) 67 68 This method gets called when the service daemon 69 needs to confirm a passkey for an authentication. 70 71 To confirm the value it should return an empty reply 72 or an error in case the passkey is invalid. 73 74 Possible errors: org.bluez.Error.Rejected 75 org.bluez.Error.Canceled 76 77 void RequestPairingConsent(object device) 78 79 This method gets called when the service daemon 80 needs to confirm an incoming pairing request. 81 82 To accept it should return an empty reply 83 or an error to reject. 84 85 Possible errors: org.bluez.Error.Rejected 86 org.bluez.Error.Canceled 87 88 void Authorize(object device, string uuid) 89 90 This method gets called when the service daemon 91 needs to authorize a connection/service request. 92 93 Possible errors: org.bluez.Error.Rejected 94 org.bluez.Error.Canceled 95 96 void ConfirmModeChange(string mode) 97 98 This method gets called if a mode change is requested 99 that needs to be confirmed by the user. An example 100 would be leaving flight mode. 101 102 Possible errors: org.bluez.Error.Rejected 103 org.bluez.Error.Canceled 104 105 void Cancel() 106 107 This method gets called to indicate that the agent 108 request failed before a reply was returned. 109
