Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(144)

Side by Side Diff: doc/manager-api.txt

Issue 6659006: flimflam: add support for multiple profiles (Closed) Base URL: ssh://git@gitrw.chromium.org:9222/flimflam.git@master
Patch Set: Created 9 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « no previous file | doc/profile-api.txt » ('j') | doc/profile-api.txt » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 Manager hierarchy 1 Manager hierarchy
2 ================= 2 =================
3 3
4 Service org.chromium.flimflam 4 Service org.chromium.flimflam
5 Interface org.chromium.flimflam.Manager 5 Interface org.chromium.flimflam.Manager
6 Object path / 6 Object path /
7 7
8 Methods dict GetProperties() 8 Methods dict GetProperties()
9 9
10 Returns all global system properties. See the 10 Returns all global system properties. See the
(...skipping 14 matching lines...) Expand all
25 string GetState() 25 string GetState()
26 26
27 Return global connection state of a system. The 27 Return global connection state of a system. The
28 same value is return via the State property. 28 same value is return via the State property.
29 29
30 Possible Errors: [service].Error.InvalidArguments 30 Possible Errors: [service].Error.InvalidArguments
31 31
32 object CreateProfile(string name) 32 object CreateProfile(string name)
33 33
34 Create and add new profile with the specified 34 Create and add new profile with the specified
35 » » » identifier name. 35 » » » identifier name. The name should either be in the
36 » » » form ``name'' or ``~user/name'' where where ``user''
37 » » » is the login name of a user suitable for finding
38 » » » their home directory. Both strings must contain
39 » » » only alpha-numeric ASCII characters.
40
41 » » » Profiles created without a user name are stored in
42 » » » a system directory readable only by the connection
43 » » » mananger. Profiles created with a user name are
44 » » » stored in the user's home directory but readable
45 » » » only by, the connection manager.
46
47 » » » If any existing profile is specified it's contents
48 » » » are reset to a default (minimal) contents.
49
50 » » » Possible Errors: [service].Error.InvalidArguments
51 » » » » » [service].Error.AlreadyExists
52
53 » » object PushProfile(string name)
54
55 » » » Push the profile with the specified identifier
56 » » » onto the profile stack. The profile must have
57 » » » previously been created with CreateProfile.
58 » » » The profile becomes the ``active profile'' that
59 » » » is searched first when loading data and to which
60 » » » updates are stored.
61
62 » » » A profile may be pushed only once.
63
64 » » » Possible Errors: [service].Error.InvalidArguments
65 » » » » » [service].Error.AlreadyExists
66
67 » » object PopProfile(string name)
68
69 » » » Pop the top-most profile on the profile stack.
70 » » » Any profile beneath this profile becomes the
71 » » » ``active profile''. Any services using security
72 » » » settings from the popped profile are disconnected
73 » » » and the credentials invalidated (the next time
74 » » » credentials are needed they are loaded from the
75 » » » (new) active profile).
76
77 » » » The name must match the identifer of the active
78 » » » profile. This is a safeguard against accidentally
79 » » » removing the wrong profile.
80
81 » » » Note it is valid to pop all profiles from the
82 » » » stack; in this state the connection manager does
83 » » » not write any state to persistent storage.
84
85 » » » Possible Errors: [service].Error.InvalidArguments
86 » » » » » [service].Error.NotFound
87
88 » » object PopAnyProfile()
89
90 » » » Like PopProfile but do not check the profile on
91 » » » the top of the stack; pop anything.
36 92
37 Possible Errors: [service].Error.InvalidArguments 93 Possible Errors: [service].Error.InvalidArguments
38 94
39 void RemoveProfile(object path) 95 void RemoveProfile(object path)
40 96
41 Remove profile with specified object path. 97 Remove profile with specified object path.
42 98
43 It is not possible to remove the current active 99 It is not possible to remove the current active
44 profile. To remove the active profile a different 100 profile. To remove the active profile a different
45 one must be selected via ActiveProfile property 101 one must be selected via ActiveProfile property
(...skipping 197 matching lines...) Expand 10 before | Expand all | Expand 10 after
243 array{string} ConnectedTechnologies [readonly] 299 array{string} ConnectedTechnologies [readonly]
244 300
245 The list of connected technologies. The strings 301 The list of connected technologies. The strings
246 are the same as the ones from the service type. 302 are the same as the ones from the service type.
247 303
248 string DefaultTechnology [readonly] 304 string DefaultTechnology [readonly]
249 305
250 The current connected technology which holds the 306 The current connected technology which holds the
251 default route. 307 default route.
252 308
253 » » boolean OfflineMode [readwrite] 309 » » boolean OfflineMode [readonly]
254 310
255 The offline mode indicates the global setting for 311 The offline mode indicates the global setting for
256 switching all radios on or off. Changing offline mode 312 switching all radios on or off. Changing offline mode
257 to true results in powering down all devices. When 313 to true results in powering down all devices. When
258 leaving offline mode the individual policy of each 314 leaving offline mode the individual policy of each
259 device decides to switch the radio back on or not. 315 device decides to switch the radio back on or not.
260 316
261 During offline mode, it is still possible to switch 317 During offline mode, it is still possible to switch
262 certain technologies manually back on. For example 318 certain technologies manually back on. For example
263 the limited usage of WiFi or Bluetooth devices might 319 the limited usage of WiFi or Bluetooth devices might
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after
307 order as the "Services" property above, but this 363 order as the "Services" property above, but this
308 property is not considered "changed" if the ordering 364 property is not considered "changed" if the ordering
309 changes. 365 changes.
310 366
311 Changes to this list are batched up for small periods 367 Changes to this list are batched up for small periods
312 of time, so that batches of changes are collected 368 of time, so that batches of changes are collected
313 into a single message containing the final state, and 369 into a single message containing the final state, and
314 ephemeral changes where the list returns to the 370 ephemeral changes where the list returns to the
315 previous state are filtered out. 371 previous state are filtered out.
316 372
OLDNEW
« no previous file with comments | « no previous file | doc/profile-api.txt » ('j') | doc/profile-api.txt » ('J')

Powered by Google App Engine
This is Rietveld 408576698