summaryrefslogtreecommitdiff
path: root/doc/device-api.txt
blob: a098bbb48d84ba3387363198a5ee16a98560152c (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
36
37
38
39
40
41
42
43
44
45
46
Device hierarchy
================

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

Method		dict GetProperties()

			Returns all properties for the device. See the
			properties section for available properties.

			Possible Errors: org.neard.Error.DoesNotExist

		void SetProperty(string name, variant value)

			Changes the value of the specified property. Only
			properties that are listed a read-write are changeable.
			On success this will emit a PropertyChanged signal.

			Possible Errors: org.neard.Error.DoesNotExist
					 org.neard.Error.InvalidArguments

		void Push(dict attributes)

			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.

			Possible Errors: org.neard.Error.PermissionDenied
					 org.neard.Error.InvalidArguments
					 org.neard.Error.InProgress


Signals		PropertyChanged(string name, variant value)

			This signal indicates a changed value of the given
			property.


Properties	array{object} Records [readonly]

			List of NDEF records object paths.