diff options
| author | Jeevaka Badrappan <jeevaka.badrappan@elektrobit.com> | 2011-02-11 03:34:31 -0800 |
|---|---|---|
| committer | Denis Kenzior <denkenz@gmail.com> | 2011-02-11 10:29:43 -0600 |
| commit | d10a48e4e5447e91595ecfc577d25cb5c1f36915 (patch) | |
| tree | 3e229f5e5fd6a866e9072ba3081be9ab4df1d2ce /doc/sim-api.txt | |
| parent | 882ef1044444f39e4f15e3067f9e617de0dec39a (diff) | |
| download | ofono-d10a48e4e5447e91595ecfc577d25cb5c1f36915.tar.bz2 | |
doc: Update possible errors
Diffstat (limited to 'doc/sim-api.txt')
| -rw-r--r-- | doc/sim-api.txt | 37 |
1 files changed, 35 insertions, 2 deletions
diff --git a/doc/sim-api.txt b/doc/sim-api.txt index c8091f73..22fe22bd 100644 --- a/doc/sim-api.txt +++ b/doc/sim-api.txt @@ -10,23 +10,39 @@ Methods dict GetProperties() Returns SIM properties for the modem object. See the properties section for available properties. - Possible Errors: [service].Error.InvalidArguments - void ChangePin(string type, string oldpin, string newpin) Changes the pin given by string type. + Possible Errors: [service].Error.NotImplemented + [service].Error.InProgress + [service].Error.InvalidArguments + [service].Error.InvalidFormat + [service].Error.Failed + void EnterPin(string type, string pin) Enters the currently pending pin. The type value must match the pin type being asked in the PinRequired property. + Possible Errors: [service].Error.NotImplemented + [service].Error.InProgress + [service].Error.InvalidArguments + [service].Error.InvalidFormat + [service].Error.Failed + void ResetPin(string type, string puk, string newpin) Provides the unblock key to the modem and if correct resets the pin to the new value of newpin. + Possible Errors: [service].Error.NotImplemented + [service].Error.InProgress + [service].Error.InvalidArguments + [service].Error.InvalidFormat + [service].Error.Failed + void LockPin(string type, string pin) Activates the lock for the particular pin type. The @@ -35,17 +51,34 @@ Methods dict GetProperties() re-inserted. The current PIN is required for the operation to succeed. + Possible Errors: [service].Error.NotImplemented + [service].Error.InProgress + [service].Error.InvalidArguments + [service].Error.InvalidFormat + [service].Error.Failed + void UnlockPin(string type, string pin) Deactivates the lock for the particular pin type. The current PIN is required for the operation to succeed. + Possible Errors: [service].Error.NotImplemented + [service].Error.InProgress + [service].Error.InvalidArguments + [service].Error.InvalidFormat + [service].Error.Failed + array{byte} GetIcon(byte id) Obtain the icon given by id. Only ids greater than 1 are valid. XPM format is currently used to return the icon data. + Possible Errors: [service].Error.NotImplemented + [service].Error.InProgress + [service].Error.InvalidArguments + [service].Error.Failed + Signals PropertyChanged(string name, variant value) This signal indicates a changed value of the given |