summaryrefslogtreecommitdiff
path: root/doc/network-api.txt
blob: be0cf39fed68a17c4a048fa03f32e2a963a0a5f3 (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
Network hierarchy
=================

Service		org.moblin.connman
Interface	org.moblin.connman.Network
Object path	[variable prefix]/{network0,network1,...}

Methods		dict GetProperties()

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

			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.DoesNotExist

Signals		PropertyChanged(string name, variant value)

			This signal indicates a changed value of the given
			property.

Properties	string WiFi.Name [readonly]

			If the network type is WiFi, then this property is
			present and contains the network name.

		array{byte} WiFi.SSID [readonly]

			If the network type is WiFi, then this property is
			present and contains the binary SSID value.

		string WiFi.Security [readonly, readwrite]

			If the network type is WiFi, then this property is
			present and contains the security method or key
			management setting.

			For scanned networks this value is read only, but in
			case the network was manually created it is also
			changeable.

			Possible values are NONE, WPA and WPA2.

		string WiFi.Passphrase [readwrite]

			If the network type is WiFi and a passhrase is
			requires, then this property is present and contains
			the passphrase in clear text.

			For system using PolicyKit, the access to this value
			will be protected by the security policy.