summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSamuel Ortiz <sameo@linux.intel.com>2012-08-22 12:54:15 +0200
committerSamuel Ortiz <sameo@linux.intel.com>2012-08-23 12:49:43 +0200
commit21067c80b7229977be806f191d7ec93302de9ded (patch)
treeb1e7d1a2093c9b167ad9761a30c84744252b3a73 /doc
parenta884284514e30379672370e3e0014de7ca627d0e (diff)
downloadneard-21067c80b7229977be806f191d7ec93302de9ded.tar.gz
neard-21067c80b7229977be806f191d7ec93302de9ded.tar.bz2
neard-21067c80b7229977be806f191d7ec93302de9ded.zip
doc: Rename handover-agent-api to agent-api
This document now also includes the NDEF agent API description.
Diffstat (limited to 'doc')
-rw-r--r--doc/agent-api.txt (renamed from doc/handover-agent-api.txt)32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/handover-agent-api.txt b/doc/agent-api.txt
index 8806249..e1a5330 100644
--- a/doc/handover-agent-api.txt
+++ b/doc/agent-api.txt
@@ -71,3 +71,35 @@ Fields array{byte} EIR
This is a proprietary extension blob used by some
Nokia Bluetooth 2.0 devices.
+
+
+NDEFAgent hierarchy
+=======================
+
+Service unique name
+Interface org.neard.NDEFAgent
+Object path freely definable
+
+Methods dict GetNDEF(dict values) [experimental]
+
+ This method gets called when the service daemon
+ found an NDEF matching the registered type.
+
+ The parameter is a dictionary where the keys are the
+ field names and the values are the actual fields.
+
+ void Release() [experimental]
+
+ This method gets called when the service daemon
+ unregisters the agent. An agent can use it to do
+ cleanup tasks. There is no need to unregister the
+ agent, because when this method gets called it has
+ already been unregistered.
+
+Fields array{byte} NDEF
+
+ This is the raw NDEF data.
+
+ object Record
+
+ This is a record object path.