diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2010-08-11 14:31:43 -0400 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2010-08-11 14:31:43 -0400 |
| commit | 2c22a5a3a8da9968cc5b19f0c24d96c25bea6db9 (patch) | |
| tree | 7d40d56e3be939c1099a96468f50b65d3af00784 /doc/network-api.txt | |
| parent | dc8dd86672674bf4aa27c7f0206785f3d42b05fd (diff) | |
| download | ofono-2c22a5a3a8da9968cc5b19f0c24d96c25bea6db9.tar.bz2 | |
doc: Update network registration and operator API
Change the network registration API to reflect simplification in the
operator selection and scanning handling for applications.
Diffstat (limited to 'doc/network-api.txt')
| -rw-r--r-- | doc/network-api.txt | 25 |
1 files changed, 14 insertions, 11 deletions
diff --git a/doc/network-api.txt b/doc/network-api.txt index 9e8478c6..083e9184 100644 --- a/doc/network-api.txt +++ b/doc/network-api.txt @@ -36,7 +36,20 @@ Methods dict GetProperties() Possible Errors: [service].Error.InvalidArguments - array{object} ProposeScan() + array{object,dict} GetOperators() + + Retrieve array of operator object and properties. + + This method can be used to retrieve the current + operator list. This is eithe an empty list (when + not registered to any network) or a list with one + or more operators (when registered). + + This list will also return cached values of previously + seen networks. Manual updates to list can only be + done via the Scan method call. + + array{object,dict} Scan() Runs a network operator scan to discover the currently available operators. This operation can take several @@ -143,16 +156,6 @@ Properties string Mode [readonly] unavailable, this property will not be returned by GetProperties or will be set to an empty string. - array{object} Operators [readonly] - - List of all operator object paths known to the - telephony stack. The scanning for new operators is - done in the background. - - The list of operators is only useful when attempting - manual registration. The automatic registration is - the preferred method. - Network operator hierarchy ========================== |