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

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

Issue 5167004: Enhance portal check code to return connectivity_state (Closed) Base URL: ssh://git@gitrw.chromium.org:9222/flimflam.git@master
Patch Set: Maintain a little backward compatibility Created 10 years, 1 month 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 | include/service.h » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 Service hierarchy 1 Service hierarchy
2 ================= 2 =================
3 3
4 Service org.chromium.flimflam 4 Service org.chromium.flimflam
5 Interface org.chromium.flimflam.Service 5 Interface org.chromium.flimflam.Service
6 Object path [variable prefix]/{service0,service1,...} 6 Object path [variable prefix]/{service0,service1,...}
7 7
8 Methods dict GetProperties() 8 Methods dict GetProperties()
9 9
10 Returns properties for the service object. See 10 Returns properties for the service object. See
(...skipping 268 matching lines...) Expand 10 before | Expand all | Expand 10 after
279 This property is included in get requests only 279 This property is included in get requests only
280 when the requester has sufficient privileges. 280 when the requester has sufficient privileges.
281 281
282 string AuthorityPath [readwrite] 282 string AuthorityPath [readwrite]
283 283
284 If the service type is "wifi", then this 284 If the service type is "wifi", then this
285 property holds information that selects a 285 property holds information that selects a
286 certificate authority file for use in validating 286 certificate authority file for use in validating
287 server certificate recieved from the access point 287 server certificate recieved from the access point
288 during the 802.1x authentication process. 288 during the 802.1x authentication process.
289 » » » 289
290 » » string ConnectivityState [readonly]
291 » » » This property indicates whether the data
292 » » » connection is within a "walled garden", in
293 » » » which only a restricted set of IP addresses
294 » » » can be reached. A value of "restricted"
295 » » » indicates that the connection is in such a
296 » » » restricted IP pool. A value of "unrestricted"
297 » » » indicates that the connection has unrestricted
298 » » » access to the internet, and a value of "none"
299 » » » means that it is unlikely that any internet
300 » » » access is available, despite having obtained
301 » » » an IP address.
302
303 » » » This property is only valid when the service
304 » » » is the default service and is in the "ready"
305 » » » state. The default value is "unknown",
306 » » » changing to "restricted", "unrestricted" or
307 » » » "none" after enough time (~5 seconds after
308 » » » becoming the default service) has elapsed to
309 » » » establish the state of IP connectivity.
310
311 » » » This state is currently only computed for
312 » » » services of type Cellular, but it can be made
313 » » » applicable to other services types.
314
290 boolean PassphraseRequired [readonly] 315 boolean PassphraseRequired [readonly]
291 316
292 If the service type is "wifi", then this property 317 If the service type is "wifi", then this property
293 indicates if a passphrase or key (for WEP) is required. 318 indicates if a passphrase or key (for WEP) is required.
294 319
295 If a passphrase has been set already or if no 320 If a passphrase has been set already or if no
296 passphrase is needed, then this property will 321 passphrase is needed, then this property will
297 be set to false. 322 be set to false.
298 323
299 UI clients may monitor this property for a 324 UI clients may monitor this property for a
(...skipping 109 matching lines...) Expand 10 before | Expand all | Expand 10 after
409 "LTE" 3.9G 434 "LTE" 3.9G
410 "LTE Advanced" 4G 435 "LTE Advanced" 4G
411 436
412 string Cellular.RoamingState [readonly] 437 string Cellular.RoamingState [readonly]
413 438
414 If the service type is "cellular", then this property 439 If the service type is "cellular", then this property
415 gives the roaming status of the modem on the current 440 gives the roaming status of the modem on the current
416 network. Possible values are "home", "roaming", and 441 network. Possible values are "home", "roaming", and
417 "unknown". 442 "unknown".
418 443
419 boolean Cellular.RestrictedPool [readonly]
420 If the service type is "cellular", then this property
421 indicates whether the mobile data connection is within
422 a "walled garden", in which only a restricted set of
423 IP addresses can be reached. A value of "true" indicates
424 that the connection is in a restricted IP
425 pool.
426
427 This property is only valid when the service
428 is in the "ready" state. The default value is
429 "false", only changing to "true" after enough
430 time (~5 seconds after becoming the default
431 service) has elapsed to assume that the IP
432 connectivity is restricted.
433
434 string Cellular.OlpUrl [readonly] 444 string Cellular.OlpUrl [readonly]
435 445
436 If the service type is "cellular", then this property 446 If the service type is "cellular", then this property
437 gives the URL of an online payment portal (OLP) at 447 gives the URL of an online payment portal (OLP) at
438 which a user can sign up for, or modify, a mobile data 448 which a user can sign up for, or modify, a mobile data
439 plan. 449 plan.
440 450
441 string Passphrase [readwrite] 451 string Passphrase [readwrite]
442 452
443 If the service type is "wifi", then this property 453 If the service type is "wifi", then this property
(...skipping 24 matching lines...) Expand all
468 gives the 802.1X Certificate Authority Path. 478 gives the 802.1X Certificate Authority Path.
469 479
470 This property is only accessible if the caller has 480 This property is only accessible if the caller has
471 'secret' security privileges. 481 'secret' security privileges.
472 482
473 string PassphraseRequired [readonly] 483 string PassphraseRequired [readonly]
474 484
475 If the service type is "wifi", then this property 485 If the service type is "wifi", then this property
476 indicates that a Passphrase is required but not 486 indicates that a Passphrase is required but not
477 currently set. 487 currently set.
OLDNEW
« no previous file with comments | « no previous file | include/service.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698