summaryrefslogtreecommitdiff
path: root/doc/technology-api.txt
blob: f97eac0119d0436d79c05a2eb8cdb4eb7c6f0e79 (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
88
89
90
91
92
93
94
95
96
97
98
99
Technology hierarchy
====================

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

Methods		dict GetProperties()  [deprecated]

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

			Usage of this method is highly discouraged. Use
			the Manager.GetTechnologies() method instead.

			Possible Errors: [service].Error.InvalidArguments

		void SetProperty(string name, variant value)

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

			Possible Errors: [service].Error.InvalidArguments
					 [service].Error.InvalidProperty

		void Scan()

			Trigger a scan for this specific technology. The
			method call will return when a scan has been
			finished and results are available. So setting
			a longer D-Bus timeout might be a really good
			idea.

			Results will be signaled via the ServicesChanged
			signal from the manager interface.

			In case of P2P technology, results will be signaled
			via the PeersChanged signal from the manager
			interface.

Signals		PropertyChanged(string name, variant value)

			This signal indicates a changed value of the given
			property.

Properties	boolean Powered [readwrite]

			Boolean representing the power state of the
			technology. False means that the technology is
			off (and is available RF-Killed) while True means
			that the technology is enabled.

		boolean Connected [readonly]

			Boolean representing if a technology is connected.

			This is just a convience property for allowing the
			UI to easily show if this technology has an active
			connection or not.

			If this property is True it means that at least one
			service of this technology is in ready state.

		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.