Index: doc/service-api.txt |
diff --git a/doc/service-api.txt b/doc/service-api.txt |
index a67387a9b5491179b9a7f1db26d36edb0fc65c84..fbc5eff891b6db282f90f0f6a345dba0fcf58eb2 100644 |
--- a/doc/service-api.txt |
+++ b/doc/service-api.txt |
@@ -58,7 +58,7 @@ Methods dict GetProperties() |
method will fail. |
This method can also be used to abort a previous |
- connectiong attempt via the Connect method. |
+ connection attempt via the Connect method. |
Possible Errors: [service].Error.InvalidArguments |
@@ -100,9 +100,9 @@ Methods dict GetProperties() |
Possible Errors: [service].Error.InvalidArguments |
- void ActivateCellularModem() |
+ void ActivateCellularModem(string carrier) |
- Activate a cellular modem. |
+ Activate a cellular modem on the provided carrier. |
This method returns immediately. The caller |
can either poll the Cellular.ActivationState |
@@ -117,14 +117,14 @@ Methods dict GetProperties() |
If this method is called for a non-cellular |
service or on a service associated with a |
non-CDMA device, it will return a NotSupported |
- error. If the device is already activated |
- nothing is returned, but if the device needs |
- to be activated an InProgress error is |
- returned. |
+ error. |
+ |
+ If the device is already activated nothing is returned. |
+ but if the device needs to be activated an InProgress |
+ error is returned. |
+ Expected Result: [service].Error.InProgress |
Possible Errors: [service].Error.NotSupported |
- Possible Errors: [service].Error.InProgress |
- |
Signals PropertyChanged(string name, variant value) |
@@ -151,7 +151,7 @@ Properties string State [readonly] |
"association" and "disconnect" are intermediate states |
associated with connection-based devices such as wifi |
- and celluar. These are exposed for UI applications to |
+ and cellular. These are exposed for UI applications to |
provide more fine-grained feedback. |
"ready" means the device is fully setup and ready for |
@@ -233,7 +233,7 @@ Properties string State [readonly] |
type "802_1x". |
This property is included in get requests only |
- when the requestor has sufficient privileges. |
+ when the requester has sufficient privileges. |
Note that no PropertyChanged signals are sent for |
this property. The PassphraseRequired property |
@@ -242,11 +242,11 @@ Properties string State [readonly] |
string Identity [readwrite] |
If the service type is "wifi", then this property |
- holds a client identity string used in setting up services of |
- type "802_1x". |
+ holds a client identity string used in setting up |
+ services of type "802_1x". |
This property is included in get requests only |
- when the requestor has sufficient privileges. |
+ when the requester has sufficient privileges. |
string CertPath [readwrite] |
@@ -277,7 +277,7 @@ Properties string State [readonly] |
parameter name is poorly chosen for this use. |
This property is included in get requests only |
- when the requestor has sufficient privileges. |
+ when the requester has sufficient privileges. |
boolean PassphraseRequired [readonly] |
@@ -319,8 +319,11 @@ Properties string State [readonly] |
For favorite services it is possible to change |
this value to prevent or permit automatic |
connection attempts. |
+ |
+ For non favorite services, this always reads FALSE and |
+ is not writeable. |
- string Device [readonly] |
+ object Device [readonly] |
The object path of the device associated with this |
service. This value may be used to retrieve and |
@@ -397,3 +400,40 @@ Properties string State [readonly] |
a "walled garden", in which only a restricted set of |
IP addresses can be reached. A value of "true" indicates |
that the connection is in a restricted IP pool. |
+ |
+ string Cellular.OlpUrl [readonly] |
+ |
+ If the service type is "cellular", then this property |
+ gives the URL of an online payment portal (OLP) at |
+ which a user can sign up for, or modify, a mobile data |
+ plan. |
+ |
+ string Passphrase [readwrite] |
+ |
+ If the service type is "wifi", then this property |
+ gives the Passphrase. |
+ |
+ This property is only accessible if the caller has |
+ 'secret' security privileges. |
+ |
+ string Identity [readwrite] |
+ |
+ If the service type is "wifi", then this property |
+ gives the 802.1X identity. |
+ |
+ This property is only accessible if the caller has |
+ 'secret' security privileges. |
+ |
+ string CertPath [readwrite] |
+ |
+ If the service type is "wifi", then this property |
+ gives the 802.1X Certificate Path. |
+ |
+ This property is only accessible if the caller has |
+ 'secret' security privileges. |
+ |
+ string PassphraseRequired [readonly] |
+ |
+ If the service type is "wifi", then this property |
+ indicates that a Passphrase is required but not |
+ currently set. |