summaryrefslogtreecommitdiff
path: root/doc/device-api.txt
blob: 0852368d6119066c941bf8e58bf5c4599589a231 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Device hierarchy
================

Service		org.neard
Interface	org.neard.Device
Object path	[variable prefix]/{nfc0}/{device0, device1...}

Method		void Push(dict attributes)

			Creates an NDEF record from the attributes dictionary.

			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
					 org.neard.Error.InProgress