5 Interface net.connman.Manager
8 Methods dict GetProperties()
10 Returns all global system properties. See the
11 properties section for available properties.
13 Possible Errors: [service].Error.InvalidArguments
15 void SetProperty(string name, variant value)
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
22 Possible Errors: [service].Error.InvalidArguments
23 [service].Error.InvalidProperty
27 Return global connection state of a system. The
28 same value is return via the State property.
30 Possible Errors: [service].Error.InvalidArguments
32 object CreateProfile(string name)
34 Create and add new profile with the specified
37 Possible Errors: [service].Error.InvalidArguments
39 void RemoveProfile(object path)
41 Remove profile with specified object path.
43 It is not possible to remove the current active
44 profile. To remove the active profile a different
45 one must be selected via ActiveProfile property
48 At minimum one profile must be available all the time.
50 Possible Errors: [service].Error.InvalidArguments
52 void RequestScan(string type)
54 Request to trigger a scan for the specified
55 technology. The empty string "" triggers scanning
58 Possible Errors: [service].Error.InvalidArguments
60 void EnableTechnology(string type)
62 Enable specified type of technologies.
64 Possible Errors: [service].Error.InvalidArguments
66 void DisableTechnology(string type)
68 Disable specified type of technologies.
70 Possible Errors: [service].Error.InvalidArguments
72 array{object,dict} GetServices()
74 Returns a sorted list of tuples with service
75 object path and dictionary of service properties.
77 This list will not contain sensitive information
80 Possible Errors: [service].Error.InvalidArguments
82 object LookupService(string pattern)
84 Lookup a service matching the specific pattern.
86 Examples are interface names like "eth0", "wlan0"
87 etc. or service names like "hotspot" etc.
89 In case of multiple services match the the pattern
92 Possible Errors: [service].Error.InvalidArguments
93 [service].Error.NotUnique
94 [service].Error.NotFound
96 object ConnectService(dict network)
98 Connect to a network specified by the given
101 For connecting to a hidden WiFi network for example
102 it is required that Type = "wifi" and the SSID
103 properties are provided.
105 When successful this method will return object
106 path of the service object.
108 This method can also be used to connect to an
109 already existing service. It works exactly the
110 same as executing the Connect method from the
113 This method call will only return in case of an
114 error or when the service is fully connected. So
115 setting a longer D-Bus timeout might be a really
118 Possible Errors: [service].Error.InvalidArguments
120 object ConnectProvider(dict provider)
122 Connect to a VPN specified by the given provider
125 When successful this method will return the object
126 path of the VPN service object.
128 This method can also be used to connect to an
129 already existing VPN.
131 This method call will only return in case of an
132 error or when the service is fully connected. So
133 setting a longer D-Bus timeout might be a really
136 Possible Errors: [service].Error.InvalidArguments
138 void RegisterAgent(object path)
140 Register new agent for handling user requests.
142 Possible Errors: [service].Error.InvalidArguments
144 void UnregisterAgent(object path)
146 Unregister an existing agent.
148 Possible Errors: [service].Error.InvalidArguments
150 void RegisterCounter(object path, uint32 accuracy, uint32 period)
152 Register a new counter for user notifications.
154 The accuracy is specified in kilo-bytes and defines
155 a threshold for counter updates. Together with the
156 period value it defines how often user space needs
157 to be updated. The period value is in seconds.
159 This interface is not meant for time tracking. If
160 the time needs to be tracked down to the second, it
161 is better to have a real timer running inside the
162 application than using this interface.
164 Also getting notified for every kilo-byte is a bad
165 choice (even if the interface supports it). Something
166 like 10 kilo-byte units or better 1 mega-byte seems
167 to be a lot more reasonable and better for the user.
169 Possible Errors: [service].Error.InvalidArguments
171 void UnregisterCounter(object path)
173 Unregister an existing counter.
175 Possible Errors: [service].Error.InvalidArguments
177 object CreateSession(dict settings, object notifier)
179 Create a new session for the application. Every
180 application can create multiple session with
181 different settings. The settings are described
182 as part of the session interface.
184 The notifier allows asynchronous notification about
185 session specific changes. These changes can be
186 for online/offline state or IP address changes or
187 similar things the application is required to
190 Every application should at least create one session
191 to inform about its requirements and it purpose.
193 void DestroySession(object session)
195 Remove the previously created session. The notifier
196 will be informed via its release method.
198 If an application exits unexpectatly the session
199 will be automatically destroyed.
201 StateChanged(string state)
203 This signal is similar to the PropertyChanged signal
204 for the State property.
206 It exists for application state only care about the
207 current state and so can avoid to be woken up when
208 other details changes.
210 Properties string State [readonly]
212 The global connection state of a system. Possible
213 values are "online" if at least one connection exists
214 and "offline" if no device is connected.
216 In certain situations the state might change to
217 the value "connected". This can only be seen if
218 previously no connection was present.
220 array{string} AvailableTechnologies [readonly]
222 The list of available technologies. The strings
223 are the same as the ones from the service types.
225 array{string} EnabledTechnologies [readonly]
227 The list of enabled technologies. The strings
228 are the same as the ones from the service types.
230 array{string} ConnectedTechnologies [readonly]
232 The list of connected technologies. The strings
233 are the same as the ones from the service type.
235 string DefaultTechnology [readonly]
237 The current connected technology which holds the
240 boolean OfflineMode [readwrite]
242 The offline mode indicates the global setting for
243 switching all radios on or off. Changing offline mode
244 to true results in powering down all devices. When
245 leaving offline mode the individual policy of each
246 device decides to switch the radio back on or not.
248 During offline mode, it is still possible to switch
249 certain technologies manually back on. For example
250 the limited usage of WiFi or Bluetooth devices might
251 be allowed in some situations.
253 object ActiveProfile [readwrite]
255 Object path of the current active profile.
257 array{object} Profiles [readonly]
259 List of profile object paths.
261 array{object} Technologies [readonly]
263 List of technology object paths.
265 array{object} Services [readonly]
267 List of service object paths. The list is sorted
268 internally to have the service with the default
269 route always first and then the favorite services
270 followed by scan results.
272 This list represents the available services for the
273 current selected profile. If the profile gets changed
274 then this list will be updated.
276 The same list is available via the profile object
277 itself. It is just provided here for convenience of
278 applications only dealing with the current active
281 boolean SessionMode [readwrite]
283 This disables the auto connect feature. It should be
284 enabled when the Session API is used.
286 The default value is false.