summaryrefslogtreecommitdiff
path: root/doc/technology-api.txt
blob: 992ee56948e668eae4658d233b867caff2190c45 (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
Technology hierarchy
====================

Service		net.connman
Interface	net.connman.Technology
Object path	[variable prefix]/{technology0,technology1,...}

Methods		dict GetProperties()

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

			Possible Errors: [service].Error.InvalidArguments

Signals		PropertyChanged(string name, variant value)

			This signal indicates a changed value of the given
			property.

Properties	string State [readonly]

			The technology state information.

			Valid states are "offline", "available", "blocked",
			"enabled "and "connected".

		string Name [readonly]

			Name of this technology.

		string Type [readonly]

			The technology type (for example "ethernet" etc.)

			This information should only be used to determine
			advanced properties or showing the correct icon
			to the user.

		boolean Tethering [readwrite]

			This option allows to enable or disable the support
			for tethering. When tethering is enabled then the
			default service is bridged to all clients connected
			through the technology.

		string TetheringIdentifier [readwrite]

		       The tethering broadcasted identifier.

		       This property is only valid for the WiFi technology,
		       and is then mapped to the WiFi AP SSID clients will
		       have to join in order to gain internet connectivity.

		string TetheringPassphrase [readwrite]

		       The tethering connection passphrase.

		       This property is only valid for the WiFi technology,
		       and is then mapped to the WPA pre-shared key clients
		       will have to use in order to establish a connection.