Add support for setting proxy configuration method
[framework/connectivity/connman.git] / doc / network-lowlevel-api.txt
1 Network hierarchy
2 =================
3
4 Service         org.moblin.connman
5 Interface       org.moblin.connman.Network
6 Object path     [variable prefix]/{network0,network1,...}
7
8 Methods         dict GetProperties()
9
10                         Returns properties for the network object. See
11                         the properties section for available properties.
12
13                         Possible Errors: [service].Error.InvalidArguments
14
15 Signals         PropertyChanged(string name, variant value)
16
17                         This signal indicates a changed value of the given
18                         property.
19
20 Properties      string Address [readonly]
21
22                         The address of the network.
23
24                 string Name [readonly]
25
26                         The pretty/long version of the network name. For
27                         example in case of WiFi this should be the UTF-8
28                         valid version of the SSID.
29
30                         This property might not be available for every
31                         network. For example hidden WiFi networks will
32                         not include it.
33
34                 boolean Connected [readonly]
35
36                         Indicates that this network is currently connected.
37
38                 uint8 Strength [readonly]
39
40                         Indicates the signal strength of the network. This
41                         is a normalized value between 0 and 100.
42
43                 object Device [readonly]
44
45                         The object path of the device this networks
46                         belongs to.
47
48                 array{byte} WiFi.SSID [readonly]
49
50                         If the network type is WiFi, then this property is
51                         present and contains the binary SSID value.
52
53                 string WiFi.Mode [readonly]
54
55                         If the network type is WiFi, then this property is
56                         present and contains the mode of the network. The
57                         possible values are "managed" or "adhoc".
58
59                 string WiFi.Security [readonly]
60
61                         If the network type is WiFi, then this property is
62                         present and contains the security method or key
63                         management setting.
64
65                         Possible values are "none", "wep", "wpa" and "rsn".
66
67                 string WiFi.Passphrase [readonly]
68
69                         If the network type is WiFi and a passhrase is
70                         requires, then this property is present and contains
71                         the passphrase in clear text.
72
73                         For systems using PolicyKit, the access to this value
74                         will be protected by the security policy.