From d11e6af4bae4ffb5d543065706d9bc813b534c04 Mon Sep 17 00:00:00 2001 From: Samuel Ortiz Date: Tue, 16 Jul 2013 11:15:19 +0200 Subject: [PATCH] doc: Document the Push method dictionary content --- doc/device-api.txt | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/doc/device-api.txt b/doc/device-api.txt index 09297cd..3430bf0 100644 --- a/doc/device-api.txt +++ b/doc/device-api.txt @@ -16,10 +16,25 @@ Method dict GetProperties() Creates an NDEF record from the attributes dictionary. - 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. + The attributes argument should at least contain a + record type. The rest of the attributes dictionary + depends on the record type: + + ----------------------------------------------------- + | Type | Additional dictionary keys | + ----------------------------------------------------- + | Text | Encoding, Language, Representation | + ----------------------------------------------------- + | URI | URI | + ----------------------------------------------------- + | SmartPoster | URI | + ----------------------------------------------------- + | Handover | Carrier (wifi or/and bluetooth) | + ----------------------------------------------------- + | StaticHandover | Carrier (wifi or/and bluetooth) | + ----------------------------------------------------- + | MIME | MIME, Payload (optional) | + ----------------------------------------------------- Possible Errors: org.neard.Error.PermissionDenied org.neard.Error.InvalidArguments -- 2.7.4