doc/agent-api.txt

   1 HandoverAgent hierarchy
   2 =======================
   3
   4 Service         unique name
   5 Interface       org.neard.HandoverAgent
   6 Object path     freely definable
   7
   8 Methods         dict RequestOOB(dict values) [experimental]
   9
  10                         This method gets called when the service daemon
  11                         needs to get Out Of Band data from the handover
  12                         agent, typically the BlueZ daemon.
  13
  14                         The service daemon will use this OOB data to build
  15                         a Handover Request or Select message and send it to
  16                         remote device.
  17
  18                         Values parameter is optional. It should be a dictionary
  19                         where the keys are the field names and the values are
  20                         the actual fields. If provided it should contain remote
  21                         Out Of Band data received in Handover Request message.
  22                         Those data will be stored for future use (i.e. when
  23                         remote initialize pairing) and providing those will not
  24                         initialize pairing.
  25
  26                         The return value should be a dictionary where the
  27                         keys are the field names and the values are the
  28                         actual fields.
  29
  30                         Possible Errors: org.neard.HandoverAgent.Error.NotSupported
  31                                          org.neard.HandoverAgent.Error.NoSuchDevice
  32                                          org.neard.HandoverAgent.Error.InProgress
  33                                          org.neard.HandoverAgent.Error.Failed
  34
  35                 void PushOOB(dict values) [experimental]
  36
  37                         This method gets called when service daemon received
  38                         Handover Select message from selector and needs to pass
  39                         remote Out Of Band data to agent to start handover.
  40
  41                         If there is no Bluetooth adapter or if it doesn't
  42                         support simple pairing the agent will return an error.
  43
  44                         Agent shall implicitly initialize pairing if needed.
  45
  46                         This function returns when alternative carrier
  47                         (Bluetooth) is ready to be used i.e. pairing has
  48                         finished.
  49
  50                         Parameter should be a dictionary where the keys are the
  51                         field names and the values are the actual fields.
  52
  53                         Possible Errors: org.neard.HandoverAgent.Error.NotSupported
  54                                          org.neard.HandoverAgent.Error.NoSuchDevice
  55                                          org.neard.HandoverAgent.Error.InProgress
  56                                          org.neard.HandoverAgent.Error.Failed
  57
  58                 void Release() [experimental]
  59
  60                         This method gets called when the service daemon
  61                         unregisters the agent. An agent can use it to do
  62                         cleanup tasks. There is no need to unregister the
  63                         agent, because when this method gets called it has
  64                         already been unregistered.
  65
  66 Fields          array{byte} EIR
  67
  68                         This is EIR blob. Used by SSP capable devices.
  69
  70                 array{byte} nokia.com:bt
  71
  72                         This is a proprietary extension blob used by some
  73                         Nokia Bluetooth 2.0 devices.
  74
  75
  76 NDEFAgent hierarchy
  77 =======================
  78
  79 Service         unique name
  80 Interface       org.neard.NDEFAgent
  81 Object path     freely definable
  82
  83 Methods         dict GetNDEF(dict values) [experimental]
  84
  85                         This method gets called when the service daemon
  86                         found an NDEF matching the registered type.
  87
  88                         The parameter is a dictionary where the keys are the
  89                         field names and the values are the actual fields.
  90
  91                 void Release() [experimental]
  92
  93                         This method gets called when the service daemon
  94                         unregisters the agent. An agent can use it to do
  95                         cleanup tasks. There is no need to unregister the
  96                         agent, because when this method gets called it has
  97                         already been unregistered.
  98
  99 Fields          array{byte} NDEF
 100
 101                         This is the raw NDEF data.
 102
 103                 object Record
 104
 105                        This is a record object path.