Add API documentation for network interface
[connman] / doc / network-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                                          [service].Error.DoesNotExist
15
16                 void SetProperty(string name, variant value)
17
18                         Changes the value of the specified property. Only
19                         properties that are listed as read-write are
20                         changeable. On success a PropertyChanged signal
21                         will be emitted.
22
23                         Possible Errors: [service].Error.InvalidArguments
24                                          [service].Error.DoesNotExist
25
26 Signals         PropertyChanged(string name, variant value)
27
28                         This signal indicates a changed value of the given
29                         property.
30
31 Properties      string WiFi.Name [readonly]
32
33                         If the network type is WiFi, then this property is
34                         present and contains the network name.
35
36                 array{byte} WiFi.SSID [readonly]
37
38                         If the network type is WiFi, then this property is
39                         present and contains the binary SSID value.
40
41                 string WiFi.Security [readonly, readwrite]
42
43                         If the network type is WiFi, then this property is
44                         present and contains the security method or key
45                         management setting.
46
47                         For scanned networks this value is read only, but in
48                         case the network was manually created it is also
49                         changeable.
50
51                         Possible values are NONE, WPA and WPA2.
52
53                 string WiFi.Passphrase [readwrite]
54
55                         If the network type is WiFi and a passhrase is
56                         requires, then this property is present and contains
57                         the passphrase in clear text.
58
59                         For system using PolicyKit, the access to this value
60                         will be protected by the security policy.