diff options
| author | Samuel Ortiz <sameo@linux.intel.com> | 2012-01-14 01:19:08 +0100 |
|---|---|---|
| committer | Samuel Ortiz <sameo@linux.intel.com> | 2012-01-14 01:19:08 +0100 |
| commit | 7bf3dc11f58e463c48567a2a11f3001c87e405a6 (patch) | |
| tree | b847258c414f268a9f7867984febc8ab0a8edd97 /doc | |
| parent | 6855528bc6f0072065a79f88c6e4dd40d0ed1688 (diff) | |
| download | neard-7bf3dc11f58e463c48567a2a11f3001c87e405a6.tar.gz neard-7bf3dc11f58e463c48567a2a11f3001c87e405a6.tar.bz2 neard-7bf3dc11f58e463c48567a2a11f3001c87e405a6.zip | |
doc: Add an adapter publication API
Writing NDEFs to already detected targets is not following the typical NFC
workflow, where targets are de-activated once read.
Instead, NFC is designed for apps to publish data to whoever shows up in
front of them.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/adapter-api.txt | 17 | ||||
| -rw-r--r-- | doc/target-api.txt | 14 |
2 files changed, 19 insertions, 12 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt index 076f0d5..70fd0a9 100644 --- a/doc/adapter-api.txt +++ b/doc/adapter-api.txt @@ -72,6 +72,23 @@ Methods: dict GetProperties() org.neard.Error.Failed org.neard.Error.NotSupported + void Publish(dict attributes) + + Creates an NDEF record from the attributes dictionary. + The NDEF is then queued for publication. + + Only the first NDEF on the queue will be written to + an NFC tag while all of them will be pushed on a peer + to peer link. + + The attribute argument should at least contain a + record type and is described by the Record properties. + For example, one would add a type, a Language, an + Encoding and a Representation for a text record. + + Possible Errors: org.neard.Error.PermissionDenied + org.neard.Error.InvalidArguments + Signals PropertyChanged(string name, variant value) diff --git a/doc/target-api.txt b/doc/target-api.txt index fd0ac69..aa10039 100644 --- a/doc/target-api.txt +++ b/doc/target-api.txt @@ -21,23 +21,13 @@ Method dict GetProperties() Possible Errors: org.neard.Error.DoesNotExist org.neard.Error.InvalidArguments - void AddRecord(dict attributes) - - Creates and add an NDEF record to the record array. - - The attribute argument should at least contain a - record type and is described by the Record properties. - For example, one would add a type, a Language, an - Encoding and a Representation for a text record. - - Possible Errors: org.neard.Error.PermissionDenied - org.neard.Error.InvalidArguments Signals PropertyChanged(string name, variant value) This signal indicates a changed value of the given property. + Properties string Type [readonly] The NFC target type. @@ -57,7 +47,7 @@ Properties string Type [readonly] "Type 4" and "NFC-DEP" This is only valid for tag type targets. - array{object} Records [readwrite] + array{object} Records [readonly] List of NDEF records object paths. This is only valid for tag type targets. |