Add more helpers for handling profile/service support
[platform/upstream/connman.git] / doc / connection-api.txt
1 Connection hierarchy
2 ====================
3
4 Service         org.moblin.connman
5 Interface       org.moblin.connman.Connection
6 Object path     [variable prefix]/{connection0,connection1,...}
7
8 Methods         dict GetProperties()
9
10                         Returns properties for the connection 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 Type [readonly]
21
22                         The connection type (for example wifi etc.)
23
24                 string Interface [readonly]
25
26                         The connection interface (for example "eth0" etc.)
27
28                         This value is for pure informational purposes. It
29                         is not guaranteed that it is always present.
30
31                 uint8 Strength [readonly]
32
33                         Indicates the signal strength of the connection.
34
35                         This property is optional and not always present.
36
37                 boolean Default [readonly]
38
39                         Indicates if it is a default connection. It is
40                         possible to have multiple default connections.
41
42                 object Device [readonly]
43
44                         The object path of the device this connection has
45                         been established with.
46
47                 object Network [readonly]
48
49                         The object path of the network this connection
50                         belongs to.
51
52                         This property is optional and not always present.
53
54                 string IPv4.Method [readonly]
55
56                         Indicates the way how the IPv4 settings were
57                         configured. Possible values here are "dhcp"
58                         and "static".
59
60                 string IPv4.Address [readonly]
61
62                         Shows the current configured IPv4 address.