Update property documentation
[platform/upstream/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
15                 void SetProperty(string name, variant value)
16
17                         Changes the value of the specified property. Only
18                         properties that are listed as read-write are
19                         changeable. On success a PropertyChanged signal
20                         will be emitted.
21
22                         Possible Errors: [service].Error.InvalidArguments
23                                          [service].Error.DoesNotExist
24
25                 void RegisterAgent(object path)
26
27                         Register new agent for handling user requests.
28
29                         Possible Errors: [service].Error.InvalidArguments
30
31                 void UnregisterAgent(object path)
32
33                         Unregister an existing agent.
34
35                         Possible Errors: [service].Error.InvalidArguments
36
37 Signals         PropertyChanged(string name, variant value)
38
39                         This signal indicates a changed value of the given
40                         property.
41
42 Properties      string State [readonly]
43
44                         The global connection state of a system. Possible
45                         values are "online" if at least one connection exists
46                         and "offline" if no device is connected.
47
48                 boolean FlightMode [readwrite]
49
50                         The flight mode indicates the global setting for
51                         switching all radios on or off. Changing flight mode
52                         to true results in powering down all devices. When
53                         leaving flight mode the individual policy of each
54                         device decides to switch the radio back on or not.
55
56                         During flight mode, it is still possible to switch
57                         certain technologies manually back on. For example
58                         the limited usage of WiFi or Bluetooth devices might
59                         be allowed in some situations.
60
61                 array{object} Profiles [readonly]
62
63                         List of profile object paths.
64
65                 array{object} Devices [readonly]
66
67                         List of device object paths.
68
69                 array{object} Connections [readonly]
70
71                         List of active connection object paths.