~phablet-team/ofono/ofono-bug-updates

« back to all changes in this revision

Viewing changes to doc/voicecallmanager-api.txt

  • Committer: Denis Kenzior
  • Author(s): Lucas De Marchi
  • Date: 2011-03-18 23:31:14 UTC
  • Revision ID: git-v1:888e07863b24026413bac8f449de377c879e1044
message: add cancelled state

Based on patch from Yang Gu <gyagp0@gmail.com>

Show diffs side-by-side

added added

removed removed

Lines of Context:
33
33
                                "disabled" - Shows callerid, CLIR Suppression
34
34
                                                is used
35
35
 
36
 
                        The number must be a string in the following format:
37
 
                                [+][0-9*#]{1,80}
38
 
                        In other words, it must be a non-empty string
39
 
                        optionally prefixed with a '+' followed by 1 to 80
40
 
                        characters.  The character set can contain numbers,
41
 
                        '*' and '#'.  Besides this sanity checking no further
42
 
                        number validation is performed.  It is assumed the
43
 
                        network will perform further validation.  The optional
44
 
                        '+' denotes an international number format.  For
45
 
                        example:
46
 
                                +15551234567 - International format
47
 
                                5551234567 - National / Uknown format
48
 
 
49
 
                        This method is usually implemented using the ATD AT
50
 
                        command.
51
 
 
52
 
                        NOTE: If an active call (single or multiparty) exists,
53
 
                        then it is automatically put on hold if the dial
54
 
                        procedure is successful.
 
36
                        This is usually implemented using the ATD AT command.
55
37
 
56
38
                        Possible Errors: [service].Error.InProgress
57
39
                                         [service].Error.InvalidArguments
106
88
                                         [service].Error.NotImplemented
107
89
                                         [service].Error.Failed
108
90
 
109
 
                void ReleaseAndSwap()
110
 
 
111
 
                        Releases currently active call (0 or more) and
112
 
                        activates any currently held calls. Please note that
113
 
                        if the current call is a multiparty call, then all
114
 
                        parties in the multi-party call will be released.
115
 
 
116
 
                        Possible Errors: [service].Error.InProgress
117
 
                                         [service].Error.NotImplemented
118
 
                                         [service].Error.Failed
119
 
 
120
91
                void HoldAndAnswer()
121
92
 
122
93
                        Puts the current call (including multi-party calls) on
125
96
                        Held calls is invalid, since in GSM a user can have
126
97
                        only a single Held call at a time.
127
98
 
128
 
                        Possible Errors: [service].Error.InProgress
 
99
                        Possible Errors: [service].Error.InProgress
129
100
                                         [service].Error.NotImplemented
130
101
                                         [service].Error.Failed
131
102
 
132
103
                void HangupAll()
133
104
 
134
 
                        Releases all calls except waiting calls. This includes
135
 
                        multiparty calls.
 
105
                        Releases all calls.
136
106
 
137
 
                        Possible Errors: [service].Error.InProgress
 
107
                        Possible Errors: [service].Error.InProgress
138
108
                                         [service].Error.NotImplemented
139
109
                                         [service].Error.Failed
140
110
 
151
121
 
152
122
                        This is usually implemented using the +CHLD=2X command.
153
123
 
154
 
                        Possible Errors: [service].Error.InProgress
 
124
                        Possible Errors: [service].Error.InProgress
155
125
                                         [service].Error.InvalidArguments
156
126
                                         [service].Error.InvalidFormat
157
127
                                         [service].Error.NotFound
172
142
                        This is usually implemented using the +CHLD=3 AT
173
143
                        command.
174
144
 
175
 
                        Possible Errors: [service].Error.InProgress
 
145
                        Possible Errors: [service].Error.InProgress
176
146
                                         [service].Error.NotImplemented
177
147
                                         [service].Error.Failed
178
148
 
181
151
                        Hangs up the multi-party call.  All participating
182
152
                        calls are released.
183
153
 
184
 
                        Possible Errors: [service].Error.InProgress
 
154
                        Possible Errors: [service].Error.InProgress
185
155
                                         [service].Error.NotImplemented
186
156
                                         [service].Error.Failed
187
157
 
192
162
                        '*', '#', 'A', 'B', 'C', 'D'.  The last four are
193
163
                        typically not used in normal circumstances.
194
164
 
195
 
                        Possible Errors: [service].Error.InProgress
 
165
                        Possible Errors: [service].Error.InProgress
196
166
                                         [service].Error.NotImplemented
197
167
                                         [service].Error.InvalidArguments
198
168
                                         [service].Error.InvalidFormat
214
184
                        released.  The object path is no longer accessible
215
185
                        after this signal and only emitted for reference.
216
186
 
217
 
                        NOTE: If the VoiceCallManager interface becomes
218
 
                        unavailable, this signal is not guaranteed to be
219
 
                        emitted for remaining calls.  The applications are
220
 
                        expected to monitor changes in Modem.Interfaces
221
 
                        property.
222
 
 
223
187
                PropertyChanged(string property, variant value)
224
188
 
225
189
                        Signal is emitted whenever a property has changed.
238
202
                        settings for outgoing calls. In this case the type
239
203
                        parameter in the signal is set to "local".
240
204
 
241
 
                Forwarded(string type) [experimental]
 
205
                CallForwarded(string type) [experimental]
242
206
 
243
207
                        Signal emitted when an outgoing voice call is made and
244
208
                        the call has been redirected to another number due to