← Back to branch summary

~ubuntu-branches/ubuntu/trusty/sflphone/trusty

« back to all changes in this revision

Viewing changes to daemon/src/client/dbus/callmanager-introspec.xml

  • Committer: Package Import Robot
  • Author(s): Mark Purcell
  • Date: 2014-01-28 18:23:36 UTC
  • mfrom: (4.3.4 sid)
  • Revision ID: package-import@ubuntu.com-20140128182336-jrsv0k9u6cawc068
Tags: 1.3.0-1
http://bugs.debian.org/735846
http://bugs.debian.org/727164
http://bugs.debian.org/718178
http://bugs.debian.org/736583
http://bugs.debian.org/722040
http://bugs.debian.org/736746
* New upstream release 
  - Fixes "New Upstream Release" (Closes: #735846)
  - Fixes "Ringtone does not stop" (Closes: #727164)
  - Fixes "[sflphone-kde] crash on startup" (Closes: #718178)
  - Fixes "sflphone GUI crashes when call is hung up" (Closes: #736583)
* Build-Depends: ensure GnuTLS 2.6
  - libucommon-dev (>= 6.0.7-1.1), libccrtp-dev (>= 2.0.6-3)
  - Fixes "FTBFS Build-Depends libgnutls{26,28}-dev" (Closes: #722040)
* Fix "boost 1.49 is going away" unversioned Build-Depends: (Closes: #736746)
* Add Build-Depends: libsndfile-dev, nepomuk-core-dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
daemon/src/client/dbus/callmanager-introspec.xml
 
1
<?xml version="1.0" encoding="UTF-8" ?>
 
2
 
 
3
<node name="/callmanager-introspec" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
 
4
    <interface name="org.sflphone.SFLphone.CallManager">
 
5
 
 
6
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
7
            <p>The CallManager interface is used to manage call and conference related actions.</p>
 
8
            <p>Since SFLphone-daemon supports multiple incoming/outgoing calls, any actions involving a specific call must address the method by the means of a unique callID.
 
9
            SFLphone-clients is responsible for generating the callID on outgoing calls. Conversely, SFLphone-daemon will generate a unique callID for incoming calls.</p>
 
10
        </tp:docstring>
 
11
        <method name="placeCall" tp:name-for-bindings="placeCall">
 
12
            <tp:docstring>
 
13
              <p>This is the main method in order to place a new call. The call is registered with the daemon using this method.</p>
 
14
            </tp:docstring>
 
15
            <arg type="s" name="accountID" direction="in">
 
16
              <tp:docstring>
 
17
                The ID of the account with which you want to make a call. If the call is to be placed without any account by means of a SIP URI (i.e. sip:num@server), the "IP2IP_PROFILE" is passed as the accountID. For more details on accounts see the configuration manager interface.
 
18
              </tp:docstring>
 
19
            </arg>
 
20
            <arg type="s" name="callID" direction="in">
 
21
              <tp:docstring>
 
22
                The callID is a unique identifier that must be randomly generated on the client's side. Any subsequent actions refering to this call must use this callID.
 
23
              </tp:docstring>
 
24
            </arg>
 
25
            <arg type="s" name="to" direction="in">
 
26
              <tp:docstring>
 
27
                If bound to a VoIP account, then the argument is the phone number. In case of calls involving "IP2IP_PROFILE", a complete SIP URI must be specified.
 
28
              </tp:docstring>
 
29
            </arg>
 
30
            <arg type="b" name="callSucceeded" direction="out"/>
 
31
        </method>
 
32
 
 
33
        <method name="refuse" tp:name-for-bindings="refuse">
 
34
            <tp:docstring>
 
35
              Refuse an incoming call.
 
36
            </tp:docstring>
 
37
            <arg type="s" name="callID" direction="in">
 
38
              <tp:docstring>
 
39
                The callID.
 
40
              </tp:docstring>
 
41
            </arg>
 
42
            <arg type="b" name="refuseSucceeded" direction="out"/>
 
43
 
 
44
        </method>
 
45
 
 
46
        <method name="accept" tp:name-for-bindings="accept">
 
47
            <tp:docstring>
 
48
              Answer an incoming call. Automatically puts the current call on HOLD.
 
49
            </tp:docstring>
 
50
            <arg type="s" name="callID" direction="in">
 
51
              <tp:docstring>
 
52
                The callID.
 
53
              </tp:docstring>
 
54
            </arg>
 
55
            <arg type="b" name="acceptSucceeded" direction="out"/>
 
56
        </method>
 
57
 
 
58
        <method name="hangUp" tp:name-for-bindings="hangUp">
 
59
            <tp:docstring>
 
60
              Hangup a call in state "CURRENT" or "HOLD".
 
61
            </tp:docstring>
 
62
            <arg type="s" name="callID" direction="in">
 
63
              <tp:docstring>
 
64
                The callID.
 
65
              </tp:docstring>
 
66
            </arg>
 
67
            <arg type="b" name="hangupSucceeded" direction="out"/>
 
68
        </method>
 
69
 
 
70
        <method name="hangUpConference" tp:name-for-bindings="hangUpConference">
 
71
            <tp:added version="0.9.7"/>
 
72
            <tp:docstring>
 
73
              Hangup a conference, and every call participating to the conference.
 
74
            </tp:docstring>
 
75
            <arg type="s" name="confID" direction="in">
 
76
              <tp:docstring>
 
77
                The unique conference ID.
 
78
              </tp:docstring>
 
79
            </arg>
 
80
            <arg type="b" name="hangupSucceeded" direction="out"/>
 
81
        </method>
 
82
 
 
83
        <method name="hold" tp:name-for-bindings="hold">
 
84
            <tp:docstring>
 
85
              Place a call on hold.
 
86
            </tp:docstring>
 
87
            <arg type="s" name="callID" direction="in">
 
88
              <tp:docstring>
 
89
                The callID.
 
90
              </tp:docstring>
 
91
            </arg>
 
92
            <arg type="b" name="holdSucceeded" direction="out"/>
 
93
        </method>
 
94
 
 
95
        <method name="unhold" tp:name-for-bindings="unhold">
 
96
            <tp:docstring>
 
97
              Take a call off hold, and place this call in state CURRENT.
 
98
            </tp:docstring>
 
99
            <arg type="s" name="callID" direction="in">
 
100
              <tp:docstring>
 
101
                The callID.
 
102
              </tp:docstring>
 
103
            </arg>
 
104
            <arg type="b" name="unHoldSucceeded" direction="out"/>
 
105
        </method>
 
106
 
 
107
        <method name="transfer" tp:name-for-bindings="transfer">
 
108
            <tp:docstring>
 
109
              Transfer a call to the given phone number.
 
110
            </tp:docstring>
 
111
            <arg type="s" name="callID" direction="in">
 
112
              <tp:docstring>
 
113
                The callID.
 
114
              </tp:docstring>
 
115
            </arg>
 
116
            <arg type="s" name="to" direction="in">
 
117
              <tp:docstring>
 
118
                The phone number to which the call will be transferred.
 
119
              </tp:docstring>
 
120
            </arg>
 
121
            <arg type="b" name="transferSucceeded" direction="out"/>
 
122
        </method>
 
123
 
 
124
        <method name="attendedTransfer" tp:name-for-bindings="attendedTransfer">
 
125
            <tp:docstring>
 
126
              Perform an attended transfer on two calls.
 
127
            </tp:docstring>
 
128
            <arg type="s" name="transferID" direction="in">
 
129
              <tp:docstring>
 
130
                The callID of the call to be transfered.
 
131
              </tp:docstring>
 
132
            </arg>
 
133
            <arg type="s" name="targetID" direction="in">
 
134
              <tp:docstring>
 
135
                The callID of the target call.
 
136
              </tp:docstring>
 
137
            </arg>
 
138
            <arg type="b" name="transferSucceeded" direction="out"/>
 
139
        </method>
 
140
 
 
141
        <method name="playDTMF" tp:name-for-bindings="playDTMF">
 
142
            <tp:docstring>
 
143
              Dual-Tone multi-frequency. Tell the core to play dialtones. A SIP INFO message is sent to notify the server.
 
144
            </tp:docstring>
 
145
            <arg type="s" name="key" direction="in">
 
146
              <tp:docstring>
 
147
                Unicode character for pressed key.
 
148
              </tp:docstring>
 
149
            </arg>
 
150
        </method>
 
151
 
 
152
        <method name="startTone" tp:name-for-bindings="startTone">
 
153
            <tp:docstring>
 
154
              Start audio stream and play tone.
 
155
            </tp:docstring>
 
156
            <arg type="i" name="start" direction="in"/>
 
157
            <arg type="i" name="type" direction="in"/>
 
158
        </method>
 
159
 
 
160
        <method name="joinParticipant" tp:name-for-bindings="joinParticipant">
 
161
            <tp:added version="0.9.7"/>
 
162
            <tp:docstring>
 
163
              <p>Join two participants together to create a 3-way conference including the current client.</p>
 
164
              <tp:rationale>The signal <tp:member-ref>conferenceCreated</tp:member-ref> is emitted on success.</tp:rationale>
 
165
            </tp:docstring>
 
166
            <arg type="s" name="sel_callID" direction="in"/>
 
167
            <arg type="s" name="drag_callID" direction="in"/>
 
168
            <arg type="b" name="joinSucceeded" direction="out"/>
 
169
        </method>
 
170
 
 
171
        <method name="createConfFromParticipantList" tp:name-for-bindings="createConfFromParticipantList">
 
172
            <tp:added version="0.9.14"/>
 
173
            <tp:docstring>
 
174
                <p>Create a conference from a list of participants</p>
 
175
            <tp:rationale>The signal <tp:member-ref>conferenceCreated</tp:member-ref> is emitted on success.</tp:rationale>
 
176
            </tp:docstring>
 
177
            <arg type="as" name="participants" direction="in"/>
 
178
        </method>
 
179
 
 
180
        <method name="isConferenceParticipant" tp:name-for-bindings="isConferenceParticipant">
 
181
            <arg type="s" name="callID" direction="in"/>
 
182
            <arg type="b" name="isParticipant" direction="out"/>
 
183
        </method>
 
184
 
 
185
        <method name="addParticipant" tp:name-for-bindings="addParticipant">
 
186
            <tp:added version="0.9.7"/>
 
187
            <tp:docstring>
 
188
              <p>Join a new particiant to an existing conference.</p>
 
189
              <tp:rationale>The signal <tp:member-ref>conferenceChanged</tp:member-ref> is emitted on success.</tp:rationale>
 
190
            </tp:docstring>
 
191
            <arg type="s" name="callID" direction="in">
 
192
              <tp:docstring>
 
193
                The ID of the call to add to the conference
 
194
              </tp:docstring>
 
195
            </arg>
 
196
            <arg type="s" name="confID" direction="in">
 
197
              <tp:docstring>
 
198
                An existing conference ID
 
199
              </tp:docstring>
 
200
            </arg>
 
201
            <arg type="b" name="addSucceeded" direction="out"/>
 
202
        </method>
 
203
 
 
204
        <method name="addMainParticipant" tp:name-for-bindings="addMainParticipant">
 
205
            <tp:added version="0.9.7"/>
 
206
            <tp:docstring>
 
207
              <p>As the core can handle multiple calls and conferences, it may happen that the client's user leaves a conference to answer an incoming call or to start new calls. This method is used to reintroduce SFLphone-client's user into the conference.</p>
 
208
              <p>Its put the current call on HOLD or detaches SFLphone-client's user from the another conference.</p>
 
209
            </tp:docstring>
 
210
            <arg type="s" name="confID" direction="in">
 
211
              <tp:docstring>
 
212
                An existing conference ID
 
213
              </tp:docstring>
 
214
            </arg>
 
215
            <arg type="b" name="addSucceeded" direction="out"/>
 
216
        </method>
 
217
 
 
218
        <method name="detachParticipant" tp:name-for-bindings="detachParticipant">
 
219
            <tp:added version="0.9.7"/>
 
220
            <tp:docstring>
 
221
              Detach the given call from the conference. If only one participant is left, the conference is deleted and the signal <tp:member-ref>conferenceRemoved</tp:member-ref> is emited.
 
222
            </tp:docstring>
 
223
            <arg type="s" name="callID" direction="in">
 
224
              <tp:docstring>
 
225
                The call ID
 
226
              </tp:docstring>
 
227
            </arg>
 
228
            <arg type="b" name="detachSucceeded" direction="out"/>
 
229
        </method>
 
230
 
 
231
        <method name="joinConference" tp:name-for-bindings="joinConference">
 
232
            <tp:added version="0.9.7"/>
 
233
            <tp:docstring>
 
234
                Join two conferences together.
 
235
            </tp:docstring>
 
236
            <arg type="s" name="sel_confID" direction="in"/>
 
237
            <arg type="s" name="drag_confID" direction="in"/>
 
238
            <arg type="b" name="joinSucceeded" direction="out"/>
 
239
        </method>
 
240
 
 
241
        <method name="getConferenceDetails" tp:name-for-bindings="getConferenceDetails">
 
242
            <tp:added version="0.9.7"/>
 
243
            <tp:docstring>
 
244
              Returns a hashtable containing conference details.
 
245
            </tp:docstring>
 
246
            <arg type="s" name="callID" direction="in">
 
247
              <tp:docstring>
 
248
                The conference ID
 
249
              </tp:docstring>
 
250
            </arg>
 
251
            <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="MapStringString"/>
 
252
            <arg type="a{ss}" name="infos" direction="out">
 
253
              <tp:docstring>
 
254
                A map containing the ID of the conferences
 
255
                and their states:
 
256
                <ul>
 
257
                  <li>ACTIVE_ATTACHED</li>
 
258
                  <li>ACTIVE_DETACHED</li>
 
259
                  <li>HOLD</li>
 
260
                </ul>
 
261
              </tp:docstring>
 
262
            </arg>
 
263
        </method>
 
264
 
 
265
        <method name="getConferenceList" tp:name-for-bindings="getConferenceList">
 
266
            <tp:added version="0.9.7"/>
 
267
            <tp:docstring>
 
268
              Returns a list containing all active
 
269
              conferences.
 
270
              <tp:rationale>To update client status, one should
 
271
              use <tp:member-ref>getParticipantList</tp:member-ref>
 
272
              with provided conference IDs.</tp:rationale>
 
273
            </tp:docstring>
 
274
            <arg type="as" name="list" direction="out">
 
275
              <tp:docstring>
 
276
                The list of conferences.
 
277
              </tp:docstring>
 
278
            </arg>
 
279
        </method>
 
280
 
 
281
        <method name="getConferenceId" tp:name-for-bindings="getConferenceId">
 
282
            <tp:added version="1.1.0"/>
 
283
            <tp:docstring>
 
284
                If thsi call participate to a conference, return the conference id.
 
285
                Return an empty string elsewhere.
 
286
            </tp:docstring>
 
287
            <arg type="s" name="callID" direction="in">
 
288
              <tp:docstring>
 
289
                The call id.
 
290
              </tp:docstring>
 
291
            </arg>
 
292
            <arg type="s" name="confID" direction="out">
 
293
              <tp:docstring>
 
294
                A string containing the conference ID, or an empty string.
 
295
              </tp:docstring>
 
296
            </arg>
 
297
        </method>
 
298
 
 
299
        <method name="toggleRecording" tp:name-for-bindings="toggleRecording">
 
300
            <tp:docstring>
 
301
              Toggle recording for a call.
 
302
            </tp:docstring>
 
303
            <arg type="s" name="callID" direction="in">
 
304
              <tp:docstring>
 
305
                The ID of the call to start/stop recording.
 
306
              </tp:docstring>
 
307
            </arg>
 
308
            <arg type="b" name="isRecording" direction="out">
 
309
              <tp:docstring>
 
310
                Returns true is the call is being recorded. False otherwise.
 
311
              </tp:docstring>
 
312
            </arg>
 
313
        </method>
 
314
 
 
315
        <method name="setRecording" tp:name-for-bindings="setRecording">
 
316
        <annotation name="org.freedesktop.DBus.Deprecated" value="true"/>
 
317
            <tp:docstring>
 
318
              Start recording a call.
 
319
            </tp:docstring>
 
320
            <arg type="s" name="callID" direction="in">
 
321
              <tp:docstring>
 
322
                The ID of the call to record.
 
323
              </tp:docstring>
 
324
            </arg>
 
325
        </method>
 
326
 
 
327
        <method name="getIsRecording" tp:name-for-bindings="getIsRecording">
 
328
            <tp:docstring>
 
329
              Tells whether or not a call is being recorded.
 
330
            </tp:docstring>
 
331
            <arg type="s" name="callID" direction="in">
 
332
              <tp:docstring>
 
333
                The call ID.
 
334
              </tp:docstring>
 
335
            </arg>
 
336
            <arg type="b" name="isRecording" direction="out">
 
337
              <tp:docstring>
 
338
                Returns true is the call is being recorded. False otherwise.
 
339
              </tp:docstring>
 
340
            </arg>
 
341
        </method>
 
342
 
 
343
        <method name="recordPlaybackSeek" tp:name-for-bindings="recordPlaybackSeek">
 
344
            <tp:docstring>
 
345
              <p>Sets the playback position using a linear scale [0,100].</p>
 
346
            </tp:docstring>
 
347
            <arg type="d" name="value" direction="in"/>
 
348
        </method>
 
349
 
 
350
        <signal name="recordPlaybackFilepath" tp:name-for-bindings="recordPlaybackFilepath">
 
351
            <tp:docstring>
 
352
              Once after starting recording for the first time, this signal is emited to
 
353
              provide the recorded file path to client application.
 
354
            </tp:docstring>
 
355
            <arg type="s" name="callID" />
 
356
            <arg type="s" name="filepath"/>
 
357
        </signal>
 
358
 
 
359
        <signal name="recordPlaybackStopped" tp:name-for-bindings="recordPlaybackStopped">
 
360
            <tp:docstring/>
 
361
            <arg type="s" name="filepath" />
 
362
        </signal>
 
363
 
 
364
        <signal name="updatePlaybackScale" tp:name-for-bindings="updatePlaybackScale">
 
365
            <tp:docstring/>
 
366
            <arg type="s" name="filepath" />
 
367
            <arg type="i" name="position" />
 
368
            <arg type="i" name="size" />
 
369
        </signal>
 
370
 
 
371
        <method name="getCallDetails" tp:name-for-bindings="getCallDetails">
 
372
            <tp:docstring>
 
373
              Get all the details about a specific call.
 
374
            </tp:docstring>
 
375
            <arg type="s" name="callID" direction="in">
 
376
              <tp:docstring>
 
377
                The call ID.
 
378
              </tp:docstring>
 
379
            </arg>
 
380
            <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="MapStringString"/>
 
381
            <arg type="a{ss}" name="infos" direction="out" tp:type="String_String_Map">
 
382
              <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
383
                <p>A map containing the call details: </p>
 
384
                <ul>
 
385
                  <li>ACCOUNTID</li>
 
386
                  <li>PEER_NUMBER</li>
 
387
                  <li>PEER_NAME</li>
 
388
                  <li>DISPLAY_NAME</li>
 
389
                  <li>CALL_STATE</li>
 
390
                  <li>CALL_TYPE</li>
 
391
                  <li>CONF_ID</li>
 
392
                </ul>
 
393
              </tp:docstring>
 
394
            </arg>
 
395
        </method>
 
396
 
 
397
        <method name="getCallList" tp:name-for-bindings="getCallList">
 
398
            <tp:docstring>
 
399
              Get the list of active calls.
 
400
              <tp:rationale>To get the call details, iterate on the return value and call <tp:member-ref>getCallDetails</tp:member-ref> method.</tp:rationale>
 
401
            </tp:docstring>
 
402
            <arg type="as" name="list" direction="out">
 
403
              <tp:docstring>
 
404
                A list of call IDs.
 
405
              </tp:docstring>
 
406
            </arg>
 
407
        </method>
 
408
 
 
409
        <method name="getCurrentAudioCodecName" tp:name-for-bindings="getCurrentAudioCodecName">
 
410
            <arg type="s" name="callID" direction="in"/>
 
411
            <arg type="s" name="codecName" direction="out"/>
 
412
        </method>
 
413
 
 
414
        <method name="sendTextMessage" tp:name-for-bindings="sendTextMessage">
 
415
            <tp:docstring>
 
416
                Send a text message to the specified call
 
417
            </tp:docstring>
 
418
            <arg type="s" name="callID" direction="in"/>
 
419
            <arg type="s" name="message" direction="in"/>
 
420
        </method>
 
421
 
 
422
        <signal name="newCallCreated" tp:name-for-bindings="newCallCreated">
 
423
            <tp:docstring>
 
424
              <p>Notify that a call has been created.</p>
 
425
              <p>The callID generated by the daemon must be stored by the clients in order to address other actions for
 
426
                this call. This signal is emitted when call haves been created by the daemon itself.</p>
 
427
              <tp:rationale>The client must subscribe to this signal to handle calls created by other clients</tp:rationale>
 
428
            </tp:docstring>
 
429
            <arg type="s" name="accountID">
 
430
              <tp:docstring>
 
431
                The account ID of the call. Clients must notify the right account when receiving this signal.
 
432
              </tp:docstring>
 
433
            </arg>
 
434
            <arg type="s" name="callID">
 
435
              <tp:docstring>
 
436
                A new call ID.
 
437
              </tp:docstring>
 
438
            </arg>
 
439
            <arg type="s" name="to">
 
440
              <tp:docstring>
 
441
               The SIP URI this call is trying to reach.
 
442
              </tp:docstring>
 
443
            </arg>
 
444
        </signal>
 
445
 
 
446
        <signal name="incomingCall" tp:name-for-bindings="incomingCall">
 
447
            <tp:docstring>
 
448
              <p>Notify an incoming call.</p>
 
449
              <p>The callID generated by the daemon must be stored by the clients in order to address other action for
 
450
                this call. This signal is emitted when we receive a call from a remote peer</p>
 
451
              <tp:rationale>The client must subscribe to this signal to handle incoming calls.</tp:rationale>
 
452
            </tp:docstring>
 
453
            <arg type="s" name="accountID">
 
454
              <tp:docstring>
 
455
                The account ID of the callee. Clients must notify the right account when receiving this signal.
 
456
              </tp:docstring>
 
457
            </arg>
 
458
            <arg type="s" name="callID">
 
459
              <tp:docstring>
 
460
                A new call ID.
 
461
              </tp:docstring>
 
462
            </arg>
 
463
            <arg type="s" name="from">
 
464
              <tp:docstring>
 
465
                The caller phone number.
 
466
              </tp:docstring>
 
467
            </arg>
 
468
        </signal>
 
469
 
 
470
        <signal name="incomingMessage" tp:name-for-bindings="incomingMessage">
 
471
            <tp:docstring>
 
472
                Notify clients that a new text message has been received.
 
473
            </tp:docstring>
 
474
            <arg type="s" name="callID" />
 
475
            <arg type="s" name="from" />
 
476
            <arg type="s" name="message" />
 
477
        </signal>
 
478
 
 
479
        <signal name="callStateChanged" tp:name-for-bindings="callStateChanged">
 
480
            <tp:docstring>
 
481
              <p>Notify of a change in a call state.</p>
 
482
              <p>The client must subscribe to this signal.</p>
 
483
            </tp:docstring>
 
484
            <arg type="s" name="callID">
 
485
              <tp:docstring>
 
486
                The call ID.
 
487
              </tp:docstring>
 
488
            </arg>
 
489
            <arg type="s" name="state" >
 
490
              <tp:docstring>
 
491
                The acceptable states are:
 
492
                <ul>
 
493
                  <li>INCOMING: Initial state of incoming calls</li>
 
494
                  <li>RINGING: Initial state of received outgoing call</li>
 
495
                  <li>CURRENT: The normal active state of an answered call</li>
 
496
                  <li>HUNGUP: Notify that the call has been hungup by peer</li>
 
497
                  <li>BUSY</li>
 
498
                  <li>FAILURE: Error when processing a call</li>
 
499
                  <li>HOLD</li>
 
500
                  <li>UNHOLD</li>
 
501
                </ul>
 
502
              </tp:docstring>
 
503
            </arg>
 
504
        </signal>
 
505
 
 
506
        <signal name="conferenceChanged" tp:name-for-bindings="conferenceChanged">
 
507
            <tp:added version="0.9.7"/>
 
508
            <tp:docstring>
 
509
              Notify of a change in the conferences state
 
510
            </tp:docstring>
 
511
            <arg type="s" name="confID">
 
512
              <tp:docstring>
 
513
                The conference ID.
 
514
              </tp:docstring>
 
515
            </arg>
 
516
            <arg type="s" name="state">
 
517
              <tp:docstring>
 
518
                The acceptable states are:
 
519
                <ul>
 
520
                  <li>ACTIVE_ATTACHED: SFLphone user is
 
521
                  participating to this conference</li>
 
522
                  <li>ACTIVE_DETACHED: This situation can
 
523
                  occur if a call is received while
 
524
                  SFLphone user is participating to a
 
525
                  conference. In this case, one can leave
 
526
                  the conference by answering the
 
527
                  call. Other participants may continue
 
528
                  conferencing normally.</li>
 
529
                  <li>HOLD: Each call in this conference
 
530
                  is on state HOLD</li>
 
531
                </ul>
 
532
              </tp:docstring>
 
533
            </arg>
 
534
        </signal>
 
535
 
 
536
        <method name="getParticipantList" tp:name-for-bindings="getParticipantList">
 
537
            <tp:added version="0.9.7"/>
 
538
            <tp:docstring>
 
539
              Get the call IDs of every participant to a given conference. The client should keep and update the list of participants.
 
540
            </tp:docstring>
 
541
            <arg type="s" name="confID" direction="in">
 
542
              <tp:docstring>
 
543
                The conference ID.
 
544
              </tp:docstring>
 
545
            </arg>
 
546
            <arg type="as" name="list" direction="out">
 
547
              <tp:docstring>
 
548
                The list of the call IDs.
 
549
              </tp:docstring>
 
550
            </arg>
 
551
        </method>
 
552
 
 
553
        <signal name="conferenceCreated" tp:name-for-bindings="conferenceCreated">
 
554
            <tp:added version="0.9.7"/>
 
555
            <tp:docstring>
 
556
              Emited when a new conference is created. SFLphone-client is reponsible for storing the confID and call <tp:member-ref>getParticipantList</tp:member-ref> to update the display.
 
557
            </tp:docstring>
 
558
            <arg type="s" name="confID">
 
559
              <tp:docstring>
 
560
                A new conference ID.
 
561
              </tp:docstring>
 
562
            </arg>
 
563
        </signal>
 
564
 
 
565
        <signal name="conferenceRemoved" tp:name-for-bindings="conferenceRemoved">
 
566
            <tp:added version="0.9.7"/>
 
567
            <tp:docstring>
 
568
              Emited when a new conference is remove. SFLphone-client should have kept a list of current participant in order to display modification.
 
569
            </tp:docstring>
 
570
            <arg type="s" name="confID">
 
571
              <tp:docstring>
 
572
                The conference ID.
 
573
              </tp:docstring>
 
574
            </arg>
 
575
        </signal>
 
576
 
 
577
        <method name="holdConference" tp:name-for-bindings="holdConference">
 
578
            <tp:added version="0.9.7"/>
 
579
            <tp:docstring>
 
580
              Hold every call which is participating in this conference.
 
581
            </tp:docstring>
 
582
            <arg type="s" name="confID" direction="in">
 
583
              <tp:docstring>
 
584
                The conference ID.
 
585
              </tp:docstring>
 
586
            </arg>
 
587
            <arg type="b" name="holdSucceeded" direction="out"/>
 
588
        </method>
 
589
 
 
590
        <method name="unholdConference" tp:name-for-bindings="unholdConference">
 
591
            <tp:added version="0.9.7"/>
 
592
            <tp:docstring>
 
593
              Hold off every call participating in this conference.
 
594
            </tp:docstring>
 
595
            <arg type="s" name="confID" direction="in">
 
596
              <tp:docstring>
 
597
                The conference ID.
 
598
              </tp:docstring>
 
599
            </arg>
 
600
            <arg type="b" name="unholdSucceeded" direction="out"/>
 
601
        </method>
 
602
 
 
603
        <method name="startRecordedFilePlayback" tp:name-for-bindings="startRecordedFilePlayback">
 
604
            <tp:added version="0.9.14"/>
 
605
            <arg type="s" name="filepath" direction="in"/>
 
606
            <arg type="b" name="result" direction="out"/>
 
607
        </method>
 
608
 
 
609
        <method name="stopRecordedFilePlayback" tp:name-for-bindings="stopRecordedFilePlayback">
 
610
            <tp:added version="0.9.14"/>
 
611
            <tp:docstring/>
 
612
            <arg type="s" name="filepath" direction="in"/>
 
613
        </method>
 
614
 
 
615
        <signal name="sipCallStateChanged" tp:name-for-bindings="sipCallStateChanged">
 
616
            <tp:docstring>
 
617
              <p>Call state changed, SFLphone received a notification
 
618
                from registrar concerning this call.</p>
 
619
            </tp:docstring>
 
620
            <arg type="s" name="callID"  />
 
621
              <tp:docstring>
 
622
                The call ID
 
623
              </tp:docstring>
 
624
            <arg type="s" name="state"  />
 
625
              <tp:docstring>
 
626
                Description string
 
627
              </tp:docstring>
 
628
            <arg type="i" name="code"  />
 
629
              <tp:docstring>
 
630
                The SIP or IAX2 message code
 
631
              </tp:docstring>
 
632
        </signal>
 
633
 
 
634
        <signal name="voiceMailNotify" tp:name-for-bindings="voiceMailNotify">
 
635
            <tp:docstring>
 
636
              Notify the clients of the voicemail number for a specific account, if applicable.
 
637
            </tp:docstring>
 
638
            <arg type="s" name="accountID">
 
639
              <tp:docstring>
 
640
                The account ID.
 
641
              </tp:docstring>
 
642
            </arg>
 
643
            <arg type="i" name="count">
 
644
              <tp:docstring>
 
645
                The number of waiting messages.
 
646
              </tp:docstring>
 
647
            </arg>
 
648
        </signal>
 
649
 
 
650
        <signal name="transferSucceeded" tp:name-for-bindings="transferSucceeded">
 
651
            <tp:docstring>
 
652
              <p>Transfer has been successfully
 
653
              processed. Client should remove transfered
 
654
              call from call list as it is no longer
 
655
              accessible in SFLphone-daemon.</p>
 
656
            </tp:docstring>
 
657
        </signal>
 
658
 
 
659
        <signal name="transferFailed" tp:name-for-bindings="transferFailed">
 
660
            <tp:docstring>
 
661
              <p>Transfer operation failed. Corresponding
 
662
              call is no longer accessible in
 
663
              SFLphone-daemon.</p>
 
664
            </tp:docstring>
 
665
        </signal>
 
666
 
 
667
        <signal name="secureSdesOn" tp:name-for-bindings="secureSdesOn">
 
668
            <tp:added version="0.9.7"/>
 
669
            <tp:docstring>
 
670
              <p>Signal sent on SDES session success. Media transmission is encripted
 
671
              for this call only. It does not apply for a conference.</p>
 
672
              <p>A conference can be considered to be secured if and only if each
 
673
              participant is secured.</p>
 
674
            </tp:docstring>
 
675
            <arg type="s" name="callID"/>
 
676
        </signal>
 
677
 
 
678
        <signal name="secureSdesOff" tp:name-for-bindings="secureSdesOff">
 
679
            <tp:added version="0.9.7"/>
 
680
            <tp:docstring>
 
681
              <p>Sinal sent to notify that SDES session failed.</p>
 
682
              <p>Media transmission is not encrypted.</p>
 
683
            </tp:docstring>
 
684
            <arg type="s" name="callID" />
 
685
        </signal>
 
686
 
 
687
        <!-- ZRTP Methods and Signals -->
 
688
        <signal name="secureZrtpOn" tp:name-for-bindings="secureZrtpOn">
 
689
            <tp:added version="0.9.7"/>
 
690
            <arg type="s" name="callID"  />
 
691
            <arg type="s" name="cipher"  />
 
692
        </signal>
 
693
 
 
694
        <signal name="secureZrtpOff" tp:name-for-bindings="secureZrtpOff">
 
695
            <tp:added version="0.9.7"/>
 
696
            <arg type="s" name="callID" />
 
697
        </signal>
 
698
 
 
699
        <signal name="confirmGoClear" tp:name-for-bindings="confirmGoClear">
 
700
            <tp:added version="0.9.7"/>
 
701
            <arg type="s" name="callID" />
 
702
        </signal>
 
703
 
 
704
        <signal name="recordingStateChanged" tp:name-for-bindings="recordingStateChange">
 
705
           <tp:added version="1.3.0"/>
 
706
           <arg type="s" name="callID" />
 
707
           <arg type="b" name="recordingState"/>
 
708
        </signal>
 
709
 
 
710
        <signal name="zrtpNegotiationFailed" tp:name-for-bindings="zrtpNegotiationFailed">
 
711
            <tp:added version="0.9.7"/>
 
712
            <arg type="s" name="callID" />
 
713
            <arg type="s" name="reason"  />
 
714
            <arg type="s" name="severity" />
 
715
        </signal>
 
716
 
 
717
        <signal name="zrtpNotSuppOther" tp:name-for-bindings="zrtpNotSuppOther">
 
718
            <tp:added version="0.9.7"/>
 
719
            <arg type="s" name="callID" />
 
720
        </signal>
 
721
 
 
722
        <signal name="showSAS" tp:name-for-bindings="showSAS">
 
723
            <tp:added version="0.9.7"/>
 
724
            <tp:added version="0.9.7"/>
 
725
            <arg type="s" name="callID" />
 
726
            <arg type="s" name="sas"  />
 
727
            <arg type="b" name="verified"/>
 
728
        </signal>
 
729
 
 
730
        <method name="setSASVerified" tp:name-for-bindings="setSASVerified">
 
731
            <tp:added version="0.9.7"/>
 
732
            <arg type="s" name="callID" direction="in"/>
 
733
        </method>
 
734
 
 
735
        <method name="resetSASVerified" tp:name-for-bindings="resetSASVerified">
 
736
            <tp:added version="0.9.7"/>
 
737
            <arg type="s" name="callID" direction="in"/>
 
738
        </method>
 
739
 
 
740
        <method name="setConfirmGoClear" tp:name-for-bindings="setConfirmGoClear">
 
741
            <tp:added version="0.9.7"/>
 
742
            <arg type="s" name="callID" direction="in"/>
 
743
        </method>
 
744
 
 
745
        <method name="requestGoClear" tp:name-for-bindings="requestGoClear">
 
746
            <tp:added version="0.9.7"/>
 
747
            <arg type="s" name="callID" direction="in"/>
 
748
        </method>
 
749
 
 
750
        <method name="acceptEnrollment" tp:name-for-bindings="acceptEnrollment">
 
751
            <tp:added version="0.9.7"/>
 
752
            <arg type="s" name="callID" direction="in"/>
 
753
            <arg type="b" name="accepted" direction="in"/>
 
754
        </method>
 
755
    </interface>
 
756
</node>