← Back to branch summary

~indicator-network-developers/ofono/trunk.packaging

« back to all changes in this revision

Viewing changes to doc/sim-api.txt

  • Committer: Kalle Valo
  • Date: 2011-02-21 07:46:07 UTC
  • mfrom: (2738.1.2125)
  • Revision ID: kalle.valo@canonical.com-20110221074607-u4rocuj2p75kpht9
Merge trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/sim-api.txt
10
10
                        Returns SIM properties for the modem object.  See
11
11
                        the properties section for available properties.
12
12
 
13
 
                        Possible Errors: [service].Error.InvalidArguments
14
 
 
15
13
                void ChangePin(string type, string oldpin, string newpin)
16
14
 
17
15
                        Changes the pin given by string type.
18
16
 
 
17
                        Possible Errors: [service].Error.NotImplemented
 
18
                                         [service].Error.InProgress
 
19
                                         [service].Error.InvalidArguments
 
20
                                         [service].Error.InvalidFormat
 
21
                                         [service].Error.Failed
 
22
 
19
23
                void EnterPin(string type, string pin)
20
24
 
21
25
                        Enters the currently pending pin.  The type value must
22
26
                        match the pin type being asked in the PinRequired
23
27
                        property.
24
28
 
 
29
                        Possible Errors: [service].Error.NotImplemented
 
30
                                         [service].Error.InProgress
 
31
                                         [service].Error.InvalidArguments
 
32
                                         [service].Error.InvalidFormat
 
33
                                         [service].Error.Failed
 
34
 
25
35
                void ResetPin(string type, string puk, string newpin)
26
36
 
27
37
                        Provides the unblock key to the modem and if correct
28
38
                        resets the pin to the new value of newpin.
29
39
 
 
40
                        Possible Errors: [service].Error.NotImplemented
 
41
                                         [service].Error.InProgress
 
42
                                         [service].Error.InvalidArguments
 
43
                                         [service].Error.InvalidFormat
 
44
                                         [service].Error.Failed
 
45
 
30
46
                void LockPin(string type, string pin)
31
47
 
32
48
                        Activates the lock for the particular pin type.  The
35
51
                        re-inserted.  The current PIN is required for the
36
52
                        operation to succeed.
37
53
 
 
54
                        Possible Errors: [service].Error.NotImplemented
 
55
                                         [service].Error.InProgress
 
56
                                         [service].Error.InvalidArguments
 
57
                                         [service].Error.InvalidFormat
 
58
                                         [service].Error.Failed
 
59
 
38
60
                void UnlockPin(string type, string pin)
39
61
 
40
62
                        Deactivates the lock for the particular pin type.  The
41
63
                        current PIN is required for the operation to succeed.
42
64
 
 
65
                        Possible Errors: [service].Error.NotImplemented
 
66
                                         [service].Error.InProgress
 
67
                                         [service].Error.InvalidArguments
 
68
                                         [service].Error.InvalidFormat
 
69
                                         [service].Error.Failed
 
70
 
43
71
                array{byte} GetIcon(byte id)
44
72
 
45
73
                        Obtain the icon given by id.  Only ids greater than 1
46
74
                        are valid.  XPM format is currently used to return the
47
75
                        icon data.
48
76
 
 
77
                        Possible Errors: [service].Error.NotImplemented
 
78
                                         [service].Error.InProgress
 
79
                                         [service].Error.InvalidArguments
 
80
                                         [service].Error.Failed
 
81
 
49
82
Signals         PropertyChanged(string name, variant value)
50
83
 
51
84
                        This signal indicates a changed value of the given
129
162
 
130
163
                string CardIdentifier [readonly]
131
164
 
132
 
                        Contains the Intergrated Circuit Card Identifer (ICCID)
 
165
                        Contains the Integrated Circuit Card Identifer (ICCID)
133
166
                        which is read directly from the SIM.
134
167
 
135
168
                boolean FixedDialing [readonly]