← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/voicecallmanager-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/voicecallmanager-api.txt
10
10
                        Returns properties for the VoiceCallManager Interface.
11
11
                        See the properties section for available properties.
12
12
 
13
 
                        Possible Errors: [service].Error.InvalidArguments
14
 
 
15
13
                array{object,dict} GetCalls()
16
14
 
17
15
                        Get an array of call object paths and properties
37
35
 
38
36
                        This is usually implemented using the ATD AT command.
39
37
 
 
38
                        Possible Errors: [service].Error.InProgress
 
39
                                         [service].Error.InvalidArguments
 
40
                                         [service].Error.InvalidFormat
 
41
                                         [service].Error.NotImplemented
 
42
                                         [service].Error.Failed
 
43
 
40
44
                void Transfer()
41
45
 
42
46
                        Joins the currently Active (or Outgoing, depending
49
53
                        This functionality is generally implemented by using
50
54
                        the +CHLD=4 AT command.
51
55
 
 
56
                        Possible Errors: [service].Error.InProgress
 
57
                                         [service].Error.NotImplemented
 
58
                                         [service].Error.Failed
 
59
 
52
60
                void SwapCalls()
53
61
 
54
62
                        Swaps Active and Held calls.  The effect of this
65
73
                        This functionality is generally implemented by using
66
74
                        the +CHLD=2 AT command.
67
75
 
 
76
                        Possible Errors: [service].Error.InProgress
 
77
                                         [service].Error.NotImplemented
 
78
                                         [service].Error.Failed
 
79
 
68
80
                void ReleaseAndAnswer()
69
81
 
70
 
                        Releases currently active call and answers the currently
71
 
                        waiting call. Please note that if the current call is
72
 
                        a multiparty call, then all parties in the multi-party
73
 
                        call will be released.
 
82
                        Releases currently active call (0 or more) and
 
83
                        answers the currently waiting call. Please note that
 
84
                        if the current call is a multiparty call, then all
 
85
                        parties in the multi-party call will be released.
 
86
 
 
87
                        Possible Errors: [service].Error.InProgress
 
88
                                         [service].Error.NotImplemented
 
89
                                         [service].Error.Failed
74
90
 
75
91
                void HoldAndAnswer()
76
92
 
80
96
                        Held calls is invalid, since in GSM a user can have
81
97
                        only a single Held call at a time.
82
98
 
 
99
                        Possible Errors: [service].Error.InProgress
 
100
                                         [service].Error.NotImplemented
 
101
                                         [service].Error.Failed
 
102
 
83
103
                void HangupAll()
84
104
 
85
105
                        Releases all calls.
86
106
 
 
107
                        Possible Errors: [service].Error.InProgress
 
108
                                         [service].Error.NotImplemented
 
109
                                         [service].Error.Failed
 
110
 
87
111
                array{object} PrivateChat(object call)
88
112
 
89
113
                        Places the multi-party call on hold and makes desired
97
121
 
98
122
                        This is usually implemented using the +CHLD=2X command.
99
123
 
 
124
                        Possible Errors: [service].Error.InProgress
 
125
                                         [service].Error.InvalidArguments
 
126
                                         [service].Error.InvalidFormat
 
127
                                         [service].Error.NotFound
 
128
                                         [service].Error.NotImplemented
 
129
                                         [service].Error.Failed
 
130
 
100
131
                array{object} CreateMultiparty()
101
132
 
102
133
                        Joins active and held calls together into a multi-party
111
142
                        This is usually implemented using the +CHLD=3 AT
112
143
                        command.
113
144
 
 
145
                        Possible Errors: [service].Error.InProgress
 
146
                                         [service].Error.NotImplemented
 
147
                                         [service].Error.Failed
 
148
 
114
149
                void HangupMultiparty()
115
150
 
116
151
                        Hangs up the multi-party call.  All participating
117
152
                        calls are released.
118
153
 
 
154
                        Possible Errors: [service].Error.InProgress
 
155
                                         [service].Error.NotImplemented
 
156
                                         [service].Error.Failed
 
157
 
119
158
                void SendTones(string tones)
120
159
 
121
160
                        Sends the DTMF tones to the network.  The tones have
123
162
                        '*', '#', 'A', 'B', 'C', 'D'.  The last four are
124
163
                        typically not used in normal circumstances.
125
164
 
 
165
                        Possible Errors: [service].Error.InProgress
 
166
                                         [service].Error.NotImplemented
 
167
                                         [service].Error.InvalidArguments
 
168
                                         [service].Error.InvalidFormat
 
169
                                         [service].Error.Failed
 
170
 
126
171
Signals         CallAdded(object path, dict properties)
127
172
 
128
173
                        Signal that is sent when a new call is added.  It
144
189
                        Signal is emitted whenever a property has changed.
145
190
                        The new value is passed as the signal argument.
146
191
 
 
192
                BarringActive(string type) [experimental]
 
193
 
 
194
                        Signal emitted when an outgoing voice call is made and
 
195
                        the call has been barred by the network due to the
 
196
                        remote party's "Call Barring" Supplementary Services
 
197
                        settings for incoming calls. In this case the type
 
198
                        parameter in the signal set to "remote".
 
199
                        The signal is also emitted when an outgoing voice call
 
200
                        is made and the call has been barred by the network due
 
201
                        to the local "Call Barring" Supplementary Services
 
202
                        settings for outgoing calls. In this case the type
 
203
                        parameter in the signal is set to "local".
 
204
 
 
205
                CallForwarded(string type) [experimental]
 
206
 
 
207
                        Signal emitted when an outgoing voice call is made and
 
208
                        the call has been redirected to another number due to
 
209
                        the remote party's "Call Forwarding" Supplementary
 
210
                        Services settings. In this case the type parameter in
 
211
                        the signal is set to "outgoing".
 
212
                        The signal is also emitted when the incoming voice call
 
213
                        is a redirected call due to a call forwarding operation.
 
214
                        In this case the type parameter in the signal is set to
 
215
                        "incoming".
 
216
 
147
217
Properties      array{string} EmergencyNumbers [readonly]
148
218
 
149
219
                        Contains the list of emergency numbers recognized