Mention the service state property
[framework/connectivity/connman.git] / doc / service-api.txt
1 Service hierarchy
2 =================
3
4 Service         org.moblin.connman
5 Interface       org.moblin.connman.Service
6 Object path     [variable prefix]/{service0,service1,...}
7
8 Methods         dict GetProperties()
9
10                         Returns properties for the service 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 State [readonly]
21
22                         The service state information.
23
24                 string Name [readonly]
25
26                         The service name (for example "Wireless" etc.)
27
28                         This name can be used for directly displaying it in
29                         the application. It has pure informational purpose.
30
31                 string Type [readonly]
32
33                         The service type (for example "ethernet", "wifi" etc.)
34
35                         This information should only be used to determine
36                         advanced properties or showing the correct icon
37                         to the user.
38
39                 string Mode [readonly]
40
41                         If the service type is WiFi, then this property is
42                         present and contains the mode of the network. The
43                         possible values are "managed" or "adhoc".
44
45                 string Security [readonly]
46
47                         If the service type is WiFi, then this property is
48                         present and contains the security method or key
49                         management setting.
50
51                         Possible values are "none", "wep", "wpa" and "wpa2".
52
53                 uint8 Strength [readonly]
54
55                         Indicates the signal strength of the service. This
56                         is a normalized value between 0 and 100.