8ef435963ff08c5c5aa984662de75b0e9f6e46b7
[framework/connectivity/connman.git] / doc / manager-api.txt
1 Manager hierarchy
2 =================
3
4 Service         org.moblin.connman
5 Interface       org.moblin.connman.Manager
6 Object path     /
7
8 Methods         dict GetProperties()
9
10                         Returns all global system properties. See the
11                         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                 void RegisterAgent(object path)
27
28                         Register new agent for handling user requests.
29
30                         Possible Errors: [service].Error.InvalidArguments
31
32                 void UnregisterAgent(object path)
33
34                         Unregister an existing agent.
35
36                         Possible Errors: [service].Error.InvalidArguments
37
38 Signals         PropertyChanged(string name, variant value)
39
40                         This signal indicates a changed value of the given
41                         property.
42
43 Properties      string State [readonly]
44
45                         The global connection state of a system. Possible
46                         values are "online" if at least one connection exists
47                         and "offline" if no device is connected.
48
49                 array{object} Profiles [readonly]
50
51                         List of profile object paths.
52
53                 array{object} Devices [readonly]
54
55                         List of device object paths.
56
57                 array{object} Connections [readonly]
58
59                         List of active connection object paths.