summaryrefslogtreecommitdiffstats
path: root/doc/dundee-api.txt
blob: 11e988d163a64405ba941dde9e67b6fa873bb350 (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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
Manager hierarchy
=================

Service		org.ofono.dundee
Interface	org.ofono.dundee.Manager
Object path	/

Methods		array{object,dict} GetDevices()

			Get an array of device objects and properties
			that represent the currently attached devices.

			This method call should only be used once when an
			application starts up. Further device additions
			and removal shall be monitored via DeviceAdded and
			DeviceRemoved signals.

Signals		DeviceAdded(object path, dict properties)

			Signal that is sent when a new device is added.  It
			contains the object path of new device and its
			properties.

		DeviceRemoved(object path)

			Signal that is sent when a device has been removed.
			The object path is no longer accessible after this
			signal and only emitted for reference.


Device hierarchy
================

Service		org.ofono.dundee
Interface	org.ofono.dundee.Device
Object path	/{device0,device1,...}

Methods		dict GetProperties()

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

		void SetProperty(string property, variant value)

			Changes the value of the specified property. Only
			properties that are listed as readwrite are
			changeable. On success a PropertyChanged signal
			will be emitted.

			Possible Errors: [service].Error.Timedout
					 [service].Error.InvalidArguments
					 [service].Error.Failed

Signals		PropertyChanged(string name, variant value)

			This signal indicates a changed value of the given
			property.

Properties	string Name [readonly]

			Friendly name of the device.

		boolean Active [readwrite]

			Holds whether the device is connected. A
			connection will be established when this value
			is set to true. A existing connection will be
			teared down when set to false.

		dict Settings [readonly]

			Holds all the IP network settings.

			string Interface [readonly, optional]

				Holds the interface of the network interface
				used by this connection (e.g. "ppp0" "usb0")

			string Address [readonly, optional]

				Holds the IP address for this connection.

			array{string} DomainNameServers [readonly, optional]

				Holds the list of domain name servers for this
				connection.