1
<?xml version="1.0" encoding="iso-8859-1"?>
3
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>Tp::Client::ChannelTypeCallInterface Class Reference</title>
7
<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
<table border="0" cellpadding="0" cellspacing="0" width="100%">
12
<td width="1"> </td>
13
<td class="postheader" valign="center">
15
<font color="#004faf">Home</font></a> ·
16
<a href="classes.html">
17
<font color="#004faf">All Classes</font></a> ·
18
<a href="namespaces.html">
19
<font color="#004faf">All Namespaces</font></a> ·
20
<a href="modules.html">
21
<font color="#004faf">Modules</font></a> ·
22
<a href="functions.html">
23
<font color="#004faf">Functions</font></a> ·
25
<font color="#004faf">Files</font></a>
29
<!-- Generated by Doxygen 1.7.6.1 -->
30
<div id="nav-path" class="navpath">
32
<li class="navelem"><a class="el" href="a00724.html">Tp</a> </li>
33
<li class="navelem"><a class="el" href="a00728.html">Client</a> </li>
34
<li class="navelem"><a class="el" href="a00140.html">ChannelTypeCallInterface</a> </li>
40
<a href="#pub-slots">Public Slots</a> |
41
<a href="#signals">Signals</a> |
42
<a href="#pub-methods">Public Member Functions</a> |
43
<a href="#pub-static-methods">Static Public Member Functions</a> |
44
<a href="#pro-methods">Protected Member Functions</a> </div>
45
<div class="headertitle">
46
<div class="title">Tp::Client::ChannelTypeCallInterface Class Reference<div class="ingroups"><a class="el" href="a00739.html">Channel proxies</a></div></div> </div>
48
<div class="contents">
49
<!-- doxytag: class="Tp::Client::ChannelTypeCallInterface" --><!-- doxytag: inherits="Tp::AbstractInterface" -->
50
<p><code>#include <<a class="el" href="a00502_source.html">TelepathyQt/Channel</a>></code></p>
52
<p>Inherits <a class="el" href="a00037.html">Tp::AbstractInterface</a>.</p>
54
<p><a href="a01100.html">List of all members.</a></p>
55
<h2><a name="pub-slots"></a>
58
<li>QDBusPendingReply <a class="el" href="a00140.html#a96239edddf18d4058f9099425d982a5c">SetRinging</a> (int timeout=-1)
59
<li>QDBusPendingReply <a class="el" href="a00140.html#a741f81bef240cc59132133a29876be09">SetQueued</a> (int timeout=-1)
60
<li>QDBusPendingReply <a class="el" href="a00140.html#a633506fb39ef1a4d7b7d14069fcf1392">Accept</a> (int timeout=-1)
61
<li>QDBusPendingReply <a class="el" href="a00140.html#afa49096dadac8b53c436bfb698151f7e">Hangup</a> (uint reason, const QString &detailedHangupReason, const QString &message, int timeout=-1)
62
<li>QDBusPendingReply<br class="typebreak"/>
63
< QDBusObjectPath > <a class="el" href="a00140.html#ab33e95e80e652d661305d0a95fec8aca">AddContent</a> (const QString &contentName, uint contentType, uint initialDirection, int timeout=-1)
65
<h2><a name="signals"></a>
68
<li>void <a class="el" href="a00140.html#adf5123584ed15171eeec88ee0dd7cdcb">ContentAdded</a> (const QDBusObjectPath &content)
69
<li>void <a class="el" href="a00140.html#a15b7638cda497d1b3be7f6cdbd766f53">ContentRemoved</a> (const QDBusObjectPath &content, const <a class="el" href="a00090.html">Tp::CallStateReason</a> &reason)
70
<li>void <a class="el" href="a00140.html#a74e593605cb733cee4cfd96473f14e8c">CallStateChanged</a> (uint callState, uint callFlags, const <a class="el" href="a00090.html">Tp::CallStateReason</a> &callStateReason, const QVariantMap &callStateDetails)
71
<li>void <a class="el" href="a00140.html#a7e53ac3834a7321526ebb2cda3bbf04a">CallMembersChanged</a> (const <a class="el" href="a00089.html">Tp::CallMemberMap</a> &flagsChanged, const <a class="el" href="a00246.html">Tp::HandleIdentifierMap</a> &identifiers, const <a class="el" href="a00414.html">Tp::UIntList</a> &removed, const <a class="el" href="a00090.html">Tp::CallStateReason</a> &reason)
73
<h2><a name="pub-methods"></a>
74
Public Member Functions</h2>
76
<li><a class="el" href="a00140.html#aecad80b0dbd59d6f007252d82c8e87cc">ChannelTypeCallInterface</a> (const QString &busName, const QString &objectPath, QObject *parent=0)
77
<li><a class="el" href="a00140.html#a8950b8e0e52b1c4e27d012a5b1ae5b77">ChannelTypeCallInterface</a> (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
78
<li><a class="el" href="a00140.html#a16316a652a14601a29163c60840f63d5">ChannelTypeCallInterface</a> (<a class="el" href="a00216.html">Tp::DBusProxy</a> *proxy)
79
<li><a class="el" href="a00140.html#a03493dc42391870962fe7936261d254b">ChannelTypeCallInterface</a> (const <a class="el" href="a00117.html">Tp::Client::ChannelInterface</a> &mainInterface)
80
<li><a class="el" href="a00140.html#ab24514a6dd6c4ca7ff8cf1e8416b70a0">ChannelTypeCallInterface</a> (const <a class="el" href="a00117.html">Tp::Client::ChannelInterface</a> &mainInterface, QObject *parent)
81
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#a001110328039f224b70dafc475c31fbf">requestPropertyContents</a> () const
82
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#a72d3ca4955982fcd707988fcf5e03792">requestPropertyCallStateDetails</a> () const
83
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#a93fa7e2928719d075b068fa9d11d37db">requestPropertyCallState</a> () const
84
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#a6540dd7a20f6d53e154abbc5fe8b3b2e">requestPropertyCallFlags</a> () const
85
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#abec721352f707fba6f301628c49d267c">requestPropertyCallStateReason</a> () const
86
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#ae2356a39a64cc9e96ebf6c8be19aeec9">requestPropertyHardwareStreaming</a> () const
87
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#aa69dae80831c99f2e948442372b57d50">requestPropertyCallMembers</a> () const
88
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#a7b38f12b971a1328b7d3adf0a57baf13">requestPropertyMemberIdentifiers</a> () const
89
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#a830793df651ca3d88dd119ce86496e87">requestPropertyInitialTransport</a> () const
90
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#a7359b73bc1f2c36b7ecdfc0a264fd188">requestPropertyInitialAudio</a> () const
91
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#ace0f0982b16fc09cdce44f040cae1733">requestPropertyInitialVideo</a> () const
92
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#aa6088e0eb02283553550c27a7c0fc0e7">requestPropertyInitialAudioName</a> () const
93
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#a0dcb4cd44bb1b0320b7dd5217fb21ec9">requestPropertyInitialVideoName</a> () const
94
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00140.html#a167b9c345eedf5fedce33bd00a3e85a2">requestPropertyMutableContents</a> () const
95
<li><a class="el" href="a00330.html">Tp::PendingVariantMap</a> * <a class="el" href="a00140.html#a6a6c36fb3384c128a0d5d9ee9f4b2f48">requestAllProperties</a> () const
97
<h2><a name="pub-static-methods"></a>
98
Static Public Member Functions</h2>
100
<li>static QLatin1String <a class="el" href="a00140.html#a30872a6283425848b143dca8e7f7abef">staticInterfaceName</a> ()
102
<h2><a name="pro-methods"></a>
103
Protected Member Functions</h2>
105
<li>virtual void <a class="el" href="a00140.html#a50f30944805c396ded58589c48eccbdf">invalidate</a> (<a class="el" href="a00216.html">Tp::DBusProxy</a> *, const QString &, const QString &)
107
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
108
<div class="textblock"><p>Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.Call1". </p>
109
</div><hr/><h2>Constructor & Destructor Documentation</h2>
110
<a class="anchor" id="aecad80b0dbd59d6f007252d82c8e87cc"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::ChannelTypeCallInterface" ref="aecad80b0dbd59d6f007252d82c8e87cc" args="(const QString &busName, const QString &objectPath, QObject *parent=0)" -->
111
<div class="memitem">
112
<div class="memproto">
113
<table class="memname">
115
<td class="memname"><a class="el" href="a00140.html#aecad80b0dbd59d6f007252d82c8e87cc">Tp::Client::ChannelTypeCallInterface::ChannelTypeCallInterface</a> </td>
117
<td class="paramtype">const QString & </td>
118
<td class="paramname"><em>busName</em>, </td>
121
<td class="paramkey"></td>
123
<td class="paramtype">const QString & </td>
124
<td class="paramname"><em>objectPath</em>, </td>
127
<td class="paramkey"></td>
129
<td class="paramtype">QObject * </td>
130
<td class="paramname"><em>parent</em> = <code>0</code> </td>
140
<p>Creates a <a class="el" href="a00140.html">ChannelTypeCallInterface</a> associated with the given object on the session bus.</p>
141
<dl class="params"><dt><b>Parameters:</b></dt><dd>
142
<table class="params">
143
<tr><td class="paramname">busName</td><td>Name of the service the object is on. </td></tr>
144
<tr><td class="paramname">objectPath</td><td>Path to the object on the service. </td></tr>
145
<tr><td class="paramname">parent</td><td>Passed to the parent class constructor. </td></tr>
152
<a class="anchor" id="a8950b8e0e52b1c4e27d012a5b1ae5b77"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::ChannelTypeCallInterface" ref="a8950b8e0e52b1c4e27d012a5b1ae5b77" args="(const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)" -->
153
<div class="memitem">
154
<div class="memproto">
155
<table class="memname">
157
<td class="memname"><a class="el" href="a00140.html#aecad80b0dbd59d6f007252d82c8e87cc">Tp::Client::ChannelTypeCallInterface::ChannelTypeCallInterface</a> </td>
159
<td class="paramtype">const QDBusConnection & </td>
160
<td class="paramname"><em>connection</em>, </td>
163
<td class="paramkey"></td>
165
<td class="paramtype">const QString & </td>
166
<td class="paramname"><em>busName</em>, </td>
169
<td class="paramkey"></td>
171
<td class="paramtype">const QString & </td>
172
<td class="paramname"><em>objectPath</em>, </td>
175
<td class="paramkey"></td>
177
<td class="paramtype">QObject * </td>
178
<td class="paramname"><em>parent</em> = <code>0</code> </td>
188
<p>Creates a <a class="el" href="a00140.html">ChannelTypeCallInterface</a> associated with the given object on the given bus.</p>
189
<dl class="params"><dt><b>Parameters:</b></dt><dd>
190
<table class="params">
191
<tr><td class="paramname">connection</td><td>The bus via which the object can be reached. </td></tr>
192
<tr><td class="paramname">busName</td><td>Name of the service the object is on. </td></tr>
193
<tr><td class="paramname">objectPath</td><td>Path to the object on the service. </td></tr>
194
<tr><td class="paramname">parent</td><td>Passed to the parent class constructor. </td></tr>
201
<a class="anchor" id="a16316a652a14601a29163c60840f63d5"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::ChannelTypeCallInterface" ref="a16316a652a14601a29163c60840f63d5" args="(Tp::DBusProxy *proxy)" -->
202
<div class="memitem">
203
<div class="memproto">
204
<table class="memname">
206
<td class="memname"><a class="el" href="a00140.html#aecad80b0dbd59d6f007252d82c8e87cc">Tp::Client::ChannelTypeCallInterface::ChannelTypeCallInterface</a> </td>
208
<td class="paramtype"><a class="el" href="a00216.html">Tp::DBusProxy</a> * </td>
209
<td class="paramname"><em>proxy</em></td><td>)</td>
215
<p>Creates a <a class="el" href="a00140.html">ChannelTypeCallInterface</a> associated with the same object as the given proxy.</p>
216
<dl class="params"><dt><b>Parameters:</b></dt><dd>
217
<table class="params">
218
<tr><td class="paramname">proxy</td><td>The proxy to use. It will also be the QObject::parent() for this object. </td></tr>
225
<a class="anchor" id="a03493dc42391870962fe7936261d254b"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::ChannelTypeCallInterface" ref="a03493dc42391870962fe7936261d254b" args="(const Tp::Client::ChannelInterface &mainInterface)" -->
226
<div class="memitem">
227
<div class="memproto">
228
<table class="memname">
230
<td class="memname"><a class="el" href="a00140.html#aecad80b0dbd59d6f007252d82c8e87cc">Tp::Client::ChannelTypeCallInterface::ChannelTypeCallInterface</a> </td>
232
<td class="paramtype">const <a class="el" href="a00117.html">Tp::Client::ChannelInterface</a> & </td>
233
<td class="paramname"><em>mainInterface</em></td><td>)</td>
234
<td><code> [explicit]</code></td>
239
<p>Creates a <a class="el" href="a00140.html">ChannelTypeCallInterface</a> associated with the same object as the given proxy. Additionally, the created proxy will have the same parent as the given proxy.</p>
240
<dl class="params"><dt><b>Parameters:</b></dt><dd>
241
<table class="params">
242
<tr><td class="paramname">mainInterface</td><td>The proxy to use. </td></tr>
249
<a class="anchor" id="ab24514a6dd6c4ca7ff8cf1e8416b70a0"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::ChannelTypeCallInterface" ref="ab24514a6dd6c4ca7ff8cf1e8416b70a0" args="(const Tp::Client::ChannelInterface &mainInterface, QObject *parent)" -->
250
<div class="memitem">
251
<div class="memproto">
252
<table class="memname">
254
<td class="memname"><a class="el" href="a00140.html#aecad80b0dbd59d6f007252d82c8e87cc">Tp::Client::ChannelTypeCallInterface::ChannelTypeCallInterface</a> </td>
256
<td class="paramtype">const <a class="el" href="a00117.html">Tp::Client::ChannelInterface</a> & </td>
257
<td class="paramname"><em>mainInterface</em>, </td>
260
<td class="paramkey"></td>
262
<td class="paramtype">QObject * </td>
263
<td class="paramname"><em>parent</em> </td>
273
<p>Creates a <a class="el" href="a00140.html">ChannelTypeCallInterface</a> associated with the same object as the given proxy. However, a different parent object can be specified.</p>
274
<dl class="params"><dt><b>Parameters:</b></dt><dd>
275
<table class="params">
276
<tr><td class="paramname">mainInterface</td><td>The proxy to use. </td></tr>
277
<tr><td class="paramname">parent</td><td>Passed to the parent class constructor. </td></tr>
284
<hr/><h2>Member Function Documentation</h2>
285
<a class="anchor" id="a30872a6283425848b143dca8e7f7abef"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::staticInterfaceName" ref="a30872a6283425848b143dca8e7f7abef" args="()" -->
286
<div class="memitem">
287
<div class="memproto">
288
<table class="memname">
290
<td class="memname">static QLatin1String <a class="el" href="a00140.html#a30872a6283425848b143dca8e7f7abef">Tp::Client::ChannelTypeCallInterface::staticInterfaceName</a> </td>
292
<td class="paramname"></td><td>)</td>
293
<td><code> [inline, static]</code></td>
298
<p>Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.Call1", which this class represents.</p>
299
<dl class="return"><dt><b>Returns:</b></dt><dd>The D-Bus interface name. </dd></dl>
303
<a class="anchor" id="a001110328039f224b70dafc475c31fbf"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyContents" ref="a001110328039f224b70dafc475c31fbf" args="() const " -->
304
<div class="memitem">
305
<div class="memproto">
306
<table class="memname">
308
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#a001110328039f224b70dafc475c31fbf">Tp::Client::ChannelTypeCallInterface::requestPropertyContents</a> </td>
310
<td class="paramname"></td><td>)</td>
311
<td> const<code> [inline]</code></td>
316
<p>Asynchronous getter for the remote object property <code>Contents</code> of type <code><a class="el" href="a00294.html">Tp::ObjectPathList</a></code>.</p>
318
<p>The list of <a class="el" href="a00080.html">CallContentInterface</a> objects that
319
are part of this call. Change notification is via the
320
<a class="el" href="a00140.html#adf5123584ed15171eeec88ee0dd7cdcb">ContentAdded()</a> and
321
<a class="el" href="a00140.html#a15b7638cda497d1b3be7f6cdbd766f53">ContentRemoved()</a> signals.
323
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
327
<a class="anchor" id="a72d3ca4955982fcd707988fcf5e03792"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyCallStateDetails" ref="a72d3ca4955982fcd707988fcf5e03792" args="() const " -->
328
<div class="memitem">
329
<div class="memproto">
330
<table class="memname">
332
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#a72d3ca4955982fcd707988fcf5e03792">Tp::Client::ChannelTypeCallInterface::requestPropertyCallStateDetails</a> </td>
334
<td class="paramname"></td><td>)</td>
335
<td> const<code> [inline]</code></td>
340
<p>Asynchronous getter for the remote object property <code>CallStateDetails</code> of type <code>QVariantMap</code>.</p>
342
<p>A map used to provide optional extensible details for the
343
<a class="el" href="a00140.html#a93fa7e2928719d075b068fa9d11d37db">CallState </a> ,
344
<a class="el" href="a00140.html#a6540dd7a20f6d53e154abbc5fe8b3b2e">CallFlags </a> and/or
345
<a class="el" href="a00140.html#abec721352f707fba6f301628c49d267c">CallStateReason </a> .</p>
347
<p>Well-known keys and their corresponding value types include:</p>
350
<dt>hangup-message - s</dt>
351
<dd>An optional human-readable message sent when the call was ended,
352
corresponding to the Message argument to the
353
<a class="el" href="a00140.html#afa49096dadac8b53c436bfb698151f7e">Hangup()</a> method. This is only
354
applicable when the call state is <tp:value-ref type="Call_State">Ended</tp:value-ref>.
355
<div class="rationale">
356
XMPP Jingle can send such messages.
360
<dt>queue-message - s</dt>
361
<dd>An optional human-readable message sent when the local contact
362
is being held in a queue. This is only applicable when
363
<tp:value-ref type="Call_Flags">Locally_Queued</tp:value-ref> is in the call flags.
364
<div class="rationale">
365
SIP 182 notifications can have human-readable messages attached.
369
<dt>debug-message - s</dt>
370
<dd>A message giving further details of any error indicated by the
371
<a class="el" href="a00140.html#abec721352f707fba6f301628c49d267c">CallStateReason </a> . This will not
372
normally be localized or suitable for display to users, and is only
373
applicable when the call state is
374
<tp:value-ref type="Call_State">Ended</tp:value-ref>.</dd>
376
<dt>balance-required - i</dt>
377
<dd>Optionally included when a call cannot be connected because
378
there is <tp:error-ref>InsufficientBalance</tp:error-ref>,
379
indicating what the required balance would be to place this call.
380
The value of this key has the same units and scale as
381
<a class="el" href="a00169.html#a1857446a85b9180abddfeea462f2789b">ConnectionInterfaceBalanceInterface::AccountBalance </a> .
384
<dt>forwarded-to - u</dt>
385
<dd>Optionally included when the
386
<a class="el" href="a00140.html#abec721352f707fba6f301628c49d267c">CallStateReason </a> is
387
Forwarded. It indicates the handle to whom the Call was
390
<dt>forwarded-to-id - s</dt>
391
<dd>The string that would result from inspecting the
392
<code>forwarded-to</code> key
393
(i.e. the contact's identifier in the IM protocol).</dd>
395
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
399
<a class="anchor" id="a93fa7e2928719d075b068fa9d11d37db"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyCallState" ref="a93fa7e2928719d075b068fa9d11d37db" args="() const " -->
400
<div class="memitem">
401
<div class="memproto">
402
<table class="memname">
404
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#a93fa7e2928719d075b068fa9d11d37db">Tp::Client::ChannelTypeCallInterface::requestPropertyCallState</a> </td>
406
<td class="paramname"></td><td>)</td>
407
<td> const<code> [inline]</code></td>
412
<p>Asynchronous getter for the remote object property <code>CallState</code> of type <code>uint</code>.</p>
414
<p>The current high-level state of this call. The
415
<a class="el" href="a00140.html#a6540dd7a20f6d53e154abbc5fe8b3b2e">CallFlags </a> provide additional
416
information, and the <a class="el" href="a00140.html#abec721352f707fba6f301628c49d267c">CallStateReason </a>
417
and <a class="el" href="a00140.html#a72d3ca4955982fcd707988fcf5e03792">CallStateDetails </a> explain the
418
reason for the current values for those properties.</p>
420
<p>Note that when in a conference call, this property is
421
purely to show your state in joining the call. The receiver
422
(or remote contact) in this context is the conference server
423
itself. The property does not change when other call members'
426
<p>Clients MAY consider unknown values in this property to be an
428
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
432
<a class="anchor" id="a6540dd7a20f6d53e154abbc5fe8b3b2e"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyCallFlags" ref="a6540dd7a20f6d53e154abbc5fe8b3b2e" args="() const " -->
433
<div class="memitem">
434
<div class="memproto">
435
<table class="memname">
437
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#a6540dd7a20f6d53e154abbc5fe8b3b2e">Tp::Client::ChannelTypeCallInterface::requestPropertyCallFlags</a> </td>
439
<td class="paramname"></td><td>)</td>
440
<td> const<code> [inline]</code></td>
445
<p>Asynchronous getter for the remote object property <code>CallFlags</code> of type <code>uint</code>.</p>
447
<p>Flags representing the status of the call as a whole,
448
providing more specific information than the
449
<a class="el" href="a00140.html#a93fa7e2928719d075b068fa9d11d37db">CallState </a> .</p>
451
<p>Clients are expected to ignore unknown flags in this property,
454
<p>When an ongoing call is active and not on hold or has any
455
other problems, this property will be 0.</p>
456
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
460
<a class="anchor" id="abec721352f707fba6f301628c49d267c"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyCallStateReason" ref="abec721352f707fba6f301628c49d267c" args="() const " -->
461
<div class="memitem">
462
<div class="memproto">
463
<table class="memname">
465
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#abec721352f707fba6f301628c49d267c">Tp::Client::ChannelTypeCallInterface::requestPropertyCallStateReason</a> </td>
467
<td class="paramname"></td><td>)</td>
468
<td> const<code> [inline]</code></td>
473
<p>Asynchronous getter for the remote object property <code><a class="el" href="a00090.html">CallStateReason</a></code> of type <code><a class="el" href="a00090.html">Tp::CallStateReason</a></code>.</p>
475
<p>The reason for the last change to the
476
<a class="el" href="a00140.html#a93fa7e2928719d075b068fa9d11d37db">CallState </a> and/or
477
<a class="el" href="a00140.html#a6540dd7a20f6d53e154abbc5fe8b3b2e">CallFlags </a> . The
478
<a class="el" href="a00140.html#a72d3ca4955982fcd707988fcf5e03792">CallStateDetails </a> MAY provide additional
480
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
484
<a class="anchor" id="ae2356a39a64cc9e96ebf6c8be19aeec9"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyHardwareStreaming" ref="ae2356a39a64cc9e96ebf6c8be19aeec9" args="() const " -->
485
<div class="memitem">
486
<div class="memproto">
487
<table class="memname">
489
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#ae2356a39a64cc9e96ebf6c8be19aeec9">Tp::Client::ChannelTypeCallInterface::requestPropertyHardwareStreaming</a> </td>
491
<td class="paramname"></td><td>)</td>
492
<td> const<code> [inline]</code></td>
497
<p>Asynchronous getter for the remote object property <code>HardwareStreaming</code> of type <code>bool</code>.</p>
499
<p>If this property is True, all of the media streaming is done by some
500
mechanism outside the scope of Telepathy.</p>
502
<div class="rationale">
503
<p>A connection manager might be intended for a specialized hardware
504
device, which will take care of the audio streaming (e.g.
505
telepathy-yafono, which uses GSM hardware which does the actual
506
audio streaming for the call).</p>
509
<p>If this is False, the handler is responsible for doing the actual
510
media streaming for at least some contents itself. Those contents
511
will have the <a class="el" href="a00083.html">CallContentInterfaceMediaInterface</a> interface, to communicate the necessary
512
information to a streaming implementation. Connection managers SHOULD
513
operate like this, if possible.</p>
515
<div class="rationale">
516
<p>Many connection managers (such as telepathy-gabble) only do the
517
call signalling, and expect the client to do the actual streaming
519
<a href="http://farsight.freedesktop.org/">Farsight</a>, to improve
520
latency and allow better UI integration.</p>
522
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
526
<a class="anchor" id="aa69dae80831c99f2e948442372b57d50"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyCallMembers" ref="aa69dae80831c99f2e948442372b57d50" args="() const " -->
527
<div class="memitem">
528
<div class="memproto">
529
<table class="memname">
531
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#aa69dae80831c99f2e948442372b57d50">Tp::Client::ChannelTypeCallInterface::requestPropertyCallMembers</a> </td>
533
<td class="paramname"></td><td>)</td>
534
<td> const<code> [inline]</code></td>
539
<p>Asynchronous getter for the remote object property <code>CallMembers</code> of type <code><a class="el" href="a00089.html">Tp::CallMemberMap</a></code>.</p>
541
<p>A mapping from the remote contacts that are part of this call to flags
542
describing their status. This mapping never has the local user's handle
545
<p>When the call ends, this property should be an empty list,
547
<a class="el" href="a00140.html#a7e53ac3834a7321526ebb2cda3bbf04a">CallMembersChanged()</a> </p>
549
<p>If the Call implements
550
<a class="el" href="a00126.html">ChannelInterfaceGroupInterface</a> and the Group members are
551
channel-specific handles, then this call SHOULD also use
552
channel-specific handles.</p>
554
<p>Anonymous members are exposed as channel-specific handles
556
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
560
<a class="anchor" id="a7b38f12b971a1328b7d3adf0a57baf13"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyMemberIdentifiers" ref="a7b38f12b971a1328b7d3adf0a57baf13" args="() const " -->
561
<div class="memitem">
562
<div class="memproto">
563
<table class="memname">
565
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#a7b38f12b971a1328b7d3adf0a57baf13">Tp::Client::ChannelTypeCallInterface::requestPropertyMemberIdentifiers</a> </td>
567
<td class="paramname"></td><td>)</td>
568
<td> const<code> [inline]</code></td>
573
<p>Asynchronous getter for the remote object property <code>MemberIdentifiers</code> of type <code><a class="el" href="a00246.html">Tp::HandleIdentifierMap</a></code>.</p>
574
<p>The string identifiers for handles mentioned in CallMembers, to give clients the minimal information necessary to create contacts without waiting for round-trips.</p>
575
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
579
<a class="anchor" id="a830793df651ca3d88dd119ce86496e87"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyInitialTransport" ref="a830793df651ca3d88dd119ce86496e87" args="() const " -->
580
<div class="memitem">
581
<div class="memproto">
582
<table class="memname">
584
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#a830793df651ca3d88dd119ce86496e87">Tp::Client::ChannelTypeCallInterface::requestPropertyInitialTransport</a> </td>
586
<td class="paramname"></td><td>)</td>
587
<td> const<code> [inline]</code></td>
592
<p>Asynchronous getter for the remote object property <code>InitialTransport</code> of type <code>uint</code>.</p>
594
<p>If set on a requested channel, this indicates the transport that
595
should be used for this call. Where not applicable, this property
596
is defined to be <tp:value-ref type="Stream_Transport_Type">Unknown</tp:value-ref>,
597
in particular, on CMs with hardware streaming.</p>
599
<div class="rationale">
600
When implementing a voip gateway one wants the outgoing leg of the
601
gatewayed to have the same transport as the incoming leg. This
602
property allows the gateway to request a Call with the right
603
transport from the CM.
605
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
609
<a class="anchor" id="a7359b73bc1f2c36b7ecdfc0a264fd188"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyInitialAudio" ref="a7359b73bc1f2c36b7ecdfc0a264fd188" args="() const " -->
610
<div class="memitem">
611
<div class="memproto">
612
<table class="memname">
614
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#a7359b73bc1f2c36b7ecdfc0a264fd188">Tp::Client::ChannelTypeCallInterface::requestPropertyInitialAudio</a> </td>
616
<td class="paramname"></td><td>)</td>
617
<td> const<code> [inline]</code></td>
622
<p>Asynchronous getter for the remote object property <code>InitialAudio</code> of type <code>bool</code>.</p>
624
<p>If set to True in a channel request that will create a new channel,
625
the connection manager should immediately attempt to establish an
626
audio stream to the remote contact, making it unnecessary for the
627
client to call <a class="el" href="a00140.html#ab33e95e80e652d661305d0a95fec8aca">ChannelTypeCallInterface::AddContent()</a> .</p>
629
<p>If this property, or InitialVideo, is passed to EnsureChannel
630
(as opposed to CreateChannel), the connection manager SHOULD ignore
631
these properties when checking whether it can return an existing
632
channel as suitable; these properties only become significant when
633
the connection manager has decided to create a new channel.</p>
635
<p>If True on a requested channel, this indicates that the audio
636
stream has already been requested and the client does not need to
637
call RequestStreams, although it MAY still do so.</p>
639
<p>If True on an unrequested (incoming) channel, this indicates that
640
the remote contact initially requested an audio stream; this does
641
not imply that that audio stream is still active (as indicated by
642
<a class="el" href="a00140.html#a001110328039f224b70dafc475c31fbf">ChannelTypeCallInterface::Contents </a> ).</p>
644
<p>The name of this new content can be decided by using the
645
<a class="el" href="a00140.html#aa6088e0eb02283553550c27a7c0fc0e7">InitialAudioName </a> property.</p>
647
<p>Connection managers that support the <a class="el" href="a00174.html">ConnectionInterfaceContactCapabilitiesInterface</a>
648
interface SHOULD represent the capabilities of receiving audio
649
and/or video calls by including a channel class in
650
a contact's capabilities with ChannelType = Call
651
in the fixed properties dictionary, and InitialAudio and/or
652
InitialVideo in the allowed properties list. Clients wishing to
653
discover whether a particular contact is likely to be able to
654
receive audio and/or video calls SHOULD use this information.</p>
656
<div class="rationale">
657
<p>Not all clients support video calls, and it would also be
658
possible (although unlikely) to have a client which could only
659
stream video, not audio.</p>
662
<p>Clients that are willing to receive audio and/or video calls
663
SHOULD include the following among their channel classes if
664
calling <a class="el" href="a00174.html#ad60d35f6a156d335b8864787d1c2455d">ConnectionInterfaceContactCapabilitiesInterface::UpdateCapabilities()</a>
665
(clients of a <a class="el" href="a00112.html">ChannelDispatcherInterface</a>
666
SHOULD instead arrange for the ChannelDispatcher to do this,
667
by including the filters in their <a class="el" href="a00154.html#a03b88e295fd2eda13a74ca563ef3a612">ClientHandlerInterface::HandlerChannelFilter </a>
671
<li>{ ChannelType = Call }</li>
672
<li>{ ChannelType = Call, InitialAudio = True }
673
if receiving calls with audio is supported</li>
674
<li>{ ChannelType = Call, InitialVideo = True }
675
if receiving calls with video is supported</li>
678
<div class="rationale">
679
<p>Connection managers for protocols with capability discovery,
680
like XMPP, need this information to advertise the appropriate
681
capabilities for their protocol.</p>
683
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
687
<a class="anchor" id="ace0f0982b16fc09cdce44f040cae1733"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyInitialVideo" ref="ace0f0982b16fc09cdce44f040cae1733" args="() const " -->
688
<div class="memitem">
689
<div class="memproto">
690
<table class="memname">
692
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#ace0f0982b16fc09cdce44f040cae1733">Tp::Client::ChannelTypeCallInterface::requestPropertyInitialVideo</a> </td>
694
<td class="paramname"></td><td>)</td>
695
<td> const<code> [inline]</code></td>
700
<p>Asynchronous getter for the remote object property <code>InitialVideo</code> of type <code>bool</code>.</p>
702
<p>The same as <a class="el" href="a00140.html#a7359b73bc1f2c36b7ecdfc0a264fd188">InitialAudio </a> , but for
703
a video stream. This property is immutable (cannot change).</p>
705
<p>In particular, note that if this property is False, this does not
706
imply that an active video stream has not been added, only that no
707
video stream was active at the time the channel appeared.</p>
709
<p>This property is the correct way to discover whether connection
710
managers, contacts etc. support video calls; it appears in
711
capabilities structures in the same way as InitialAudio.</p>
712
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
716
<a class="anchor" id="aa6088e0eb02283553550c27a7c0fc0e7"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyInitialAudioName" ref="aa6088e0eb02283553550c27a7c0fc0e7" args="() const " -->
717
<div class="memitem">
718
<div class="memproto">
719
<table class="memname">
721
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#aa6088e0eb02283553550c27a7c0fc0e7">Tp::Client::ChannelTypeCallInterface::requestPropertyInitialAudioName</a> </td>
723
<td class="paramname"></td><td>)</td>
724
<td> const<code> [inline]</code></td>
729
<p>Asynchronous getter for the remote object property <code>InitialAudioName</code> of type <code>QString</code>.</p>
731
<p>If <a class="el" href="a00140.html#a7359b73bc1f2c36b7ecdfc0a264fd188">InitialAudio </a> is set to
732
True, then this property will name the intial audio content
733
with the value of this property.</p>
735
<div class="rationale">
736
<p>Content names are meant to be significant, but if no name
737
can be given to initial audio content, then its name cannot
738
be meaningful or even localized.</p>
741
<p>If this property is empty or missing from the channel
742
request and InitialAudio is True, then the CM must come up
743
with a sensible for the content, such as "audio".</p>
745
<p>If the protocol has no concept of stream names then this
746
property will not show up in the allowed properties list of
747
the Requestable Channel Classes for call channels.</p>
748
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
752
<a class="anchor" id="a0dcb4cd44bb1b0320b7dd5217fb21ec9"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyInitialVideoName" ref="a0dcb4cd44bb1b0320b7dd5217fb21ec9" args="() const " -->
753
<div class="memitem">
754
<div class="memproto">
755
<table class="memname">
757
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#a0dcb4cd44bb1b0320b7dd5217fb21ec9">Tp::Client::ChannelTypeCallInterface::requestPropertyInitialVideoName</a> </td>
759
<td class="paramname"></td><td>)</td>
760
<td> const<code> [inline]</code></td>
765
<p>Asynchronous getter for the remote object property <code>InitialVideoName</code> of type <code>QString</code>.</p>
768
<a class="el" href="a00140.html#aa6088e0eb02283553550c27a7c0fc0e7">InitialAudioName </a> , but for a
769
video stream created by setting
770
<a class="el" href="a00140.html#ace0f0982b16fc09cdce44f040cae1733">InitialVideo </a> to True. This
771
property is immutable and so cannot change.</p>
772
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
776
<a class="anchor" id="a167b9c345eedf5fedce33bd00a3e85a2"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestPropertyMutableContents" ref="a167b9c345eedf5fedce33bd00a3e85a2" args="() const " -->
777
<div class="memitem">
778
<div class="memproto">
779
<table class="memname">
781
<td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00140.html#a167b9c345eedf5fedce33bd00a3e85a2">Tp::Client::ChannelTypeCallInterface::requestPropertyMutableContents</a> </td>
783
<td class="paramname"></td><td>)</td>
784
<td> const<code> [inline]</code></td>
789
<p>Asynchronous getter for the remote object property <code>MutableContents</code> of type <code>bool</code>.</p>
791
<p>If True, a stream of a different content type can be added
792
after the Channel has been requested </p>
794
<p>If this property is missing, clients SHOULD assume that it is False,
795
and thus that the channel's streams cannot be changed once the call
798
<p>If this property isn't present in the "allowed" set in any of the
799
Call entries contact capabilities, then user interfaces MAY choose to
800
show a separate "call" option for each class of call.</p>
802
<div class="rationale">
803
<p>For example, once an audio-only Google Talk call has started,
804
it is not possible to add a video stream; both audio and video
805
must be requested at the start of the call if video is desired.
806
User interfaces may use this pseudo-capability as a hint to
807
display separate "Audio call" and "Video call" buttons, rather
808
than a single "Call1" button with the option to add and remove
809
video once the call has started for contacts without this flag.
812
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
816
<a class="anchor" id="a6a6c36fb3384c128a0d5d9ee9f4b2f48"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::requestAllProperties" ref="a6a6c36fb3384c128a0d5d9ee9f4b2f48" args="() const " -->
817
<div class="memitem">
818
<div class="memproto">
819
<table class="memname">
821
<td class="memname"><a class="el" href="a00330.html">Tp::PendingVariantMap</a>* <a class="el" href="a00140.html#a6a6c36fb3384c128a0d5d9ee9f4b2f48">Tp::Client::ChannelTypeCallInterface::requestAllProperties</a> </td>
823
<td class="paramname"></td><td>)</td>
824
<td> const<code> [inline]</code></td>
829
<p>Request all of the <a class="el" href="a00729.html">DBus</a> properties on the interface.</p>
830
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant map which will emit finished when the properties have been retrieved. </dd></dl>
834
<a class="anchor" id="a96239edddf18d4058f9099425d982a5c"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::SetRinging" ref="a96239edddf18d4058f9099425d982a5c" args="(int timeout=-1)" -->
835
<div class="memitem">
836
<div class="memproto">
837
<table class="memname">
839
<td class="memname">QDBusPendingReply <a class="el" href="a00140.html#a96239edddf18d4058f9099425d982a5c">Tp::Client::ChannelTypeCallInterface::SetRinging</a> </td>
841
<td class="paramtype">int </td>
842
<td class="paramname"><em>timeout</em> = <code>-1</code></td><td>)</td>
843
<td><code> [inline, slot]</code></td>
848
<p>Begins a call to the D-Bus method <code>SetRinging</code> on the remote object.</p>
850
<p>Indicate that the local user has been alerted about the incoming
853
<p>This method is only useful if the
854
channel's <a class="el" href="a00117.html#a32516a093708b2b8accc930b8252dcfa">ChannelInterface::Requested </a>
855
property is False, and
856
the <a class="el" href="a00140.html#a93fa7e2928719d075b068fa9d11d37db">CallState </a> is
857
<tp:value-ref type="Call_State">Initialised</tp:value-ref> (an incoming
858
call is ready and waiting for the user to be notified). Calling this method
859
SHOULD set <a class="el" href="a00140.html#a6540dd7a20f6d53e154abbc5fe8b3b2e">CallFlags </a> ' bit
860
<tp:value-ref type="Call_Flags">Locally_Ringing</tp:value-ref>, and notify the
861
remote contact that the local user has been alerted (if the
862
protocol supports this); repeated calls to this method
863
SHOULD succeed, but have no further effect.</p>
865
<p>In all other states, this method SHOULD fail with the error
867
<p>Note that <em>timeout</em> is ignored as of now. It will be used once <a href="http://bugreports.qt.nokia.com/browse/QTBUG-11775">http://bugreports.qt.nokia.com/browse/QTBUG-11775</a> is fixed.</p>
868
<dl class="params"><dt><b>Parameters:</b></dt><dd>
869
<table class="params">
870
<tr><td class="paramname">timeout</td><td>The timeout in milliseconds. </td></tr>
877
<a class="anchor" id="a741f81bef240cc59132133a29876be09"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::SetQueued" ref="a741f81bef240cc59132133a29876be09" args="(int timeout=-1)" -->
878
<div class="memitem">
879
<div class="memproto">
880
<table class="memname">
882
<td class="memname">QDBusPendingReply <a class="el" href="a00140.html#a741f81bef240cc59132133a29876be09">Tp::Client::ChannelTypeCallInterface::SetQueued</a> </td>
884
<td class="paramtype">int </td>
885
<td class="paramname"><em>timeout</em> = <code>-1</code></td><td>)</td>
886
<td><code> [inline, slot]</code></td>
891
<p>Begins a call to the D-Bus method <code>SetQueued</code> on the remote object.</p>
893
<p>Notifies the CM that the local user is already in a call, so this
894
call has been put in a call-waiting style queue.</p>
896
<p>This method is only useful if the
897
channel's <a class="el" href="a00117.html#a32516a093708b2b8accc930b8252dcfa">ChannelInterface::Requested </a>
898
property is False, and
899
the <a class="el" href="a00140.html#a93fa7e2928719d075b068fa9d11d37db">CallState </a> is
900
<tp:value-ref type="Call_State">Initialising</tp:value-ref> or
901
<tp:value-ref type="Call_State">Initialised</tp:value-ref>. Calling this method
902
SHOULD set <a class="el" href="a00140.html#a6540dd7a20f6d53e154abbc5fe8b3b2e">CallFlags </a> ' bit
903
<tp:value-ref type="Call_Flags">Locally_Queued</tp:value-ref>, and notify the
904
remote contact that the call is in a queue (if the
905
protocol supports this); repeated calls to this method
906
SHOULD succeed, but have no further effect.</p>
908
<p>Locally_Queued is a little like Locally_Held, but applies to calls that have not
909
been Accepted (the Locally_Queued flag should be unset by the CM when Accept
910
is called). It should also be set in response to the state of the
911
world, rather than in response to user action.</p>
912
<p>Note that <em>timeout</em> is ignored as of now. It will be used once <a href="http://bugreports.qt.nokia.com/browse/QTBUG-11775">http://bugreports.qt.nokia.com/browse/QTBUG-11775</a> is fixed.</p>
913
<dl class="params"><dt><b>Parameters:</b></dt><dd>
914
<table class="params">
915
<tr><td class="paramname">timeout</td><td>The timeout in milliseconds. </td></tr>
922
<a class="anchor" id="a633506fb39ef1a4d7b7d14069fcf1392"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::Accept" ref="a633506fb39ef1a4d7b7d14069fcf1392" args="(int timeout=-1)" -->
923
<div class="memitem">
924
<div class="memproto">
925
<table class="memname">
927
<td class="memname">QDBusPendingReply <a class="el" href="a00140.html#a633506fb39ef1a4d7b7d14069fcf1392">Tp::Client::ChannelTypeCallInterface::Accept</a> </td>
929
<td class="paramtype">int </td>
930
<td class="paramname"><em>timeout</em> = <code>-1</code></td><td>)</td>
931
<td><code> [inline, slot]</code></td>
936
<p>Begins a call to the D-Bus method <code>Accept</code> on the remote object.</p>
938
<p>For incoming calls in state
939
<tp:value-ref type="Call_State">Initialised</tp:value-ref>, accept the incoming call.
940
This changes the <a class="el" href="a00140.html#a93fa7e2928719d075b068fa9d11d37db">CallState </a> to
941
<tp:value-ref type="Call_State">Accepted</tp:value-ref>.</p>
943
<p>For outgoing calls in state
944
<tp:value-ref type="Call_State">Pending_Initiator</tp:value-ref>, actually
945
call the remote contact; this changes the
946
<a class="el" href="a00140.html#a93fa7e2928719d075b068fa9d11d37db">CallState </a> to
947
<tp:value-ref type="Call_State">Initialising</tp:value-ref>.</p>
949
<p>Otherwise, this method SHOULD fail with the error NotAvailable.</p>
951
<p>This method should be called exactly once per Call, by whatever
952
client (user interface) is handling the channel.</p>
954
<p>When this method is called, for each <a class="el" href="a00080.html">CallContentInterface</a> whose
955
<a class="el" href="a00080.html#a53328c2b0aa861de4355f6ddd8d3db2b">CallContentInterface::Disposition </a> is
956
<tp:value-ref type="Call_Content_Disposition">Initial</tp:value-ref>, any
957
streams where the <a class="el" href="a00093.html#a636a90f26988c095262820a24dbdebd0">CallStreamInterface::LocalSendingState </a>
958
is <tp:value-ref type="Sending_State">Pending_Send</tp:value-ref> will be
959
moved to <tp:value-ref type="Sending_State">Sending</tp:value-ref> as if
960
<a class="el" href="a00093.html#a6e6c0077d52bb72755cbb27c7219620a">CallStreamInterface::SetSending()</a> (True) had been called.</p>
961
<p>Note that <em>timeout</em> is ignored as of now. It will be used once <a href="http://bugreports.qt.nokia.com/browse/QTBUG-11775">http://bugreports.qt.nokia.com/browse/QTBUG-11775</a> is fixed.</p>
962
<dl class="params"><dt><b>Parameters:</b></dt><dd>
963
<table class="params">
964
<tr><td class="paramname">timeout</td><td>The timeout in milliseconds. </td></tr>
971
<a class="anchor" id="afa49096dadac8b53c436bfb698151f7e"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::Hangup" ref="afa49096dadac8b53c436bfb698151f7e" args="(uint reason, const QString &detailedHangupReason, const QString &message, int timeout=-1)" -->
972
<div class="memitem">
973
<div class="memproto">
974
<table class="memname">
976
<td class="memname">QDBusPendingReply <a class="el" href="a00140.html#afa49096dadac8b53c436bfb698151f7e">Tp::Client::ChannelTypeCallInterface::Hangup</a> </td>
978
<td class="paramtype">uint </td>
979
<td class="paramname"><em>reason</em>, </td>
982
<td class="paramkey"></td>
984
<td class="paramtype">const QString & </td>
985
<td class="paramname"><em>detailedHangupReason</em>, </td>
988
<td class="paramkey"></td>
990
<td class="paramtype">const QString & </td>
991
<td class="paramname"><em>message</em>, </td>
994
<td class="paramkey"></td>
996
<td class="paramtype">int </td>
997
<td class="paramname"><em>timeout</em> = <code>-1</code> </td>
1002
<td></td><td><code> [inline, slot]</code></td>
1006
<div class="memdoc">
1007
<p>Begins a call to the D-Bus method <code>Hangup</code> on the remote object.</p>
1008
<p>Request that the call is ended. All contents will be removed from the Call so that the Contents property will be the empty list.</p>
1009
<p>Note that <em>timeout</em> is ignored as of now. It will be used once <a href="http://bugreports.qt.nokia.com/browse/QTBUG-11775">http://bugreports.qt.nokia.com/browse/QTBUG-11775</a> is fixed.</p>
1010
<dl class="params"><dt><b>Parameters:</b></dt><dd>
1011
<table class="params">
1012
<tr><td class="paramname">reason</td><td>A generic hangup reason.</td></tr>
1013
<tr><td class="paramname">detailedHangupReason</td><td>A more specific reason for the call hangup, if one is available, or an empty string otherwise.</td></tr>
1014
<tr><td class="paramname">message</td><td>A human-readable message to be sent to the remote contact(s). XMPP Jingle allows calls to be terminated with a human-readable message. </td></tr>
1015
<tr><td class="paramname">timeout</td><td>The timeout in milliseconds. </td></tr>
1022
<a class="anchor" id="ab33e95e80e652d661305d0a95fec8aca"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::AddContent" ref="ab33e95e80e652d661305d0a95fec8aca" args="(const QString &contentName, uint contentType, uint initialDirection, int timeout=-1)" -->
1023
<div class="memitem">
1024
<div class="memproto">
1025
<table class="memname">
1027
<td class="memname">QDBusPendingReply<QDBusObjectPath> <a class="el" href="a00140.html#ab33e95e80e652d661305d0a95fec8aca">Tp::Client::ChannelTypeCallInterface::AddContent</a> </td>
1029
<td class="paramtype">const QString & </td>
1030
<td class="paramname"><em>contentName</em>, </td>
1033
<td class="paramkey"></td>
1035
<td class="paramtype">uint </td>
1036
<td class="paramname"><em>contentType</em>, </td>
1039
<td class="paramkey"></td>
1041
<td class="paramtype">uint </td>
1042
<td class="paramname"><em>initialDirection</em>, </td>
1045
<td class="paramkey"></td>
1047
<td class="paramtype">int </td>
1048
<td class="paramname"><em>timeout</em> = <code>-1</code> </td>
1053
<td></td><td><code> [inline, slot]</code></td>
1057
<div class="memdoc">
1058
<p>Begins a call to the D-Bus method <code>AddContent</code> on the remote object.</p>
1059
<p>Request that a new Content of type Content_Type is added to the Call1. Handlers should check the value of the MutableContents property before trying to add another content as it might not be allowed.</p>
1060
<p>Note that <em>timeout</em> is ignored as of now. It will be used once <a href="http://bugreports.qt.nokia.com/browse/QTBUG-11775">http://bugreports.qt.nokia.com/browse/QTBUG-11775</a> is fixed.</p>
1061
<dl class="params"><dt><b>Parameters:</b></dt><dd>
1062
<table class="params">
1063
<tr><td class="paramname">contentName</td><td>The suggested name of the content to add. The content name property should be meaningful, so should be given a name which is significant to the user. The name could be a localized "audio", "video" or perhaps include some string identifying the source, such as a webcam identifier. If there is already a content with the same name as this property then a sensible suffix should be added. For example, if this argument is "audio" but a content of the same name already exists, a sensible suffix such as " (1)" is appended to name the new content "audio (1)". A further content with the name "audio" would then be named "audio (2)".</td></tr>
1064
<tr><td class="paramname">contentType</td><td>The media stream type of the content to be added to the call.</td></tr>
1065
<tr><td class="paramname">initialDirection</td><td>The requested initial direction of the new content. </td></tr>
1066
<tr><td class="paramname">timeout</td><td>The timeout in milliseconds.</td></tr>
1070
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
1071
<p>Path to the newly-created Call1.Content object. </p>
1075
<a class="anchor" id="adf5123584ed15171eeec88ee0dd7cdcb"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::ContentAdded" ref="adf5123584ed15171eeec88ee0dd7cdcb" args="(const QDBusObjectPath &content)" -->
1076
<div class="memitem">
1077
<div class="memproto">
1078
<table class="memname">
1080
<td class="memname">void <a class="el" href="a00140.html#adf5123584ed15171eeec88ee0dd7cdcb">Tp::Client::ChannelTypeCallInterface::ContentAdded</a> </td>
1082
<td class="paramtype">const QDBusObjectPath & </td>
1083
<td class="paramname"><em>content</em></td><td>)</td>
1084
<td><code> [signal]</code></td>
1088
<div class="memdoc">
1089
<p>Represents the signal <code>ContentAdded</code> on the remote object.</p>
1091
<p>Emitted when a new <a class="el" href="a00080.html">CallContentInterface</a> is added to the call.</p>
1092
<dl class="params"><dt><b>Parameters:</b></dt><dd>
1093
<table class="params">
1094
<tr><td class="paramname">content</td><td>Path to the newly-created Content object. </td></tr>
1101
<a class="anchor" id="a15b7638cda497d1b3be7f6cdbd766f53"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::ContentRemoved" ref="a15b7638cda497d1b3be7f6cdbd766f53" args="(const QDBusObjectPath &content, const Tp::CallStateReason &reason)" -->
1102
<div class="memitem">
1103
<div class="memproto">
1104
<table class="memname">
1106
<td class="memname">void <a class="el" href="a00140.html#a15b7638cda497d1b3be7f6cdbd766f53">Tp::Client::ChannelTypeCallInterface::ContentRemoved</a> </td>
1108
<td class="paramtype">const QDBusObjectPath & </td>
1109
<td class="paramname"><em>content</em>, </td>
1112
<td class="paramkey"></td>
1114
<td class="paramtype">const <a class="el" href="a00090.html">Tp::CallStateReason</a> & </td>
1115
<td class="paramname"><em>reason</em> </td>
1120
<td></td><td><code> [signal]</code></td>
1124
<div class="memdoc">
1125
<p>Represents the signal <code>ContentRemoved</code> on the remote object.</p>
1127
<p>Emitted when a <a class="el" href="a00080.html">CallContentInterface</a> is removed from the call.</p>
1128
<dl class="params"><dt><b>Parameters:</b></dt><dd>
1129
<table class="params">
1130
<tr><td class="paramname">content</td><td>The Content which was removed.</td></tr>
1131
<tr><td class="paramname">reason</td><td>Why the content was removed. </td></tr>
1138
<a class="anchor" id="a74e593605cb733cee4cfd96473f14e8c"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::CallStateChanged" ref="a74e593605cb733cee4cfd96473f14e8c" args="(uint callState, uint callFlags, const Tp::CallStateReason &callStateReason, const QVariantMap &callStateDetails)" -->
1139
<div class="memitem">
1140
<div class="memproto">
1141
<table class="memname">
1143
<td class="memname">void <a class="el" href="a00140.html#a74e593605cb733cee4cfd96473f14e8c">Tp::Client::ChannelTypeCallInterface::CallStateChanged</a> </td>
1145
<td class="paramtype">uint </td>
1146
<td class="paramname"><em>callState</em>, </td>
1149
<td class="paramkey"></td>
1151
<td class="paramtype">uint </td>
1152
<td class="paramname"><em>callFlags</em>, </td>
1155
<td class="paramkey"></td>
1157
<td class="paramtype">const <a class="el" href="a00090.html">Tp::CallStateReason</a> & </td>
1158
<td class="paramname"><em>callStateReason</em>, </td>
1161
<td class="paramkey"></td>
1163
<td class="paramtype">const QVariantMap & </td>
1164
<td class="paramname"><em>callStateDetails</em> </td>
1169
<td></td><td><code> [signal]</code></td>
1173
<div class="memdoc">
1174
<p>Represents the signal <code>CallStateChanged</code> on the remote object.</p>
1176
<p>Emitted when the state of the call as a whole changes.</p>
1178
<p>This signal is emitted for any change in the properties
1179
corresponding to its arguments, even if the other properties
1180
referenced remain unchanged.</p>
1181
<dl class="params"><dt><b>Parameters:</b></dt><dd>
1182
<table class="params">
1183
<tr><td class="paramname">callState</td><td>The new value of the CallState property.</td></tr>
1184
<tr><td class="paramname">callFlags</td><td>The new value of the CallFlags property.</td></tr>
1185
<tr><td class="paramname">callStateReason</td><td>The new value of the <a class="el" href="a00090.html">CallStateReason</a> property.</td></tr>
1186
<tr><td class="paramname">callStateDetails</td><td>The new value of the CallStateDetails property. </td></tr>
1193
<a class="anchor" id="a7e53ac3834a7321526ebb2cda3bbf04a"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::CallMembersChanged" ref="a7e53ac3834a7321526ebb2cda3bbf04a" args="(const Tp::CallMemberMap &flagsChanged, const Tp::HandleIdentifierMap &identifiers, const Tp::UIntList &removed, const Tp::CallStateReason &reason)" -->
1194
<div class="memitem">
1195
<div class="memproto">
1196
<table class="memname">
1198
<td class="memname">void <a class="el" href="a00140.html#a7e53ac3834a7321526ebb2cda3bbf04a">Tp::Client::ChannelTypeCallInterface::CallMembersChanged</a> </td>
1200
<td class="paramtype">const <a class="el" href="a00089.html">Tp::CallMemberMap</a> & </td>
1201
<td class="paramname"><em>flagsChanged</em>, </td>
1204
<td class="paramkey"></td>
1206
<td class="paramtype">const <a class="el" href="a00246.html">Tp::HandleIdentifierMap</a> & </td>
1207
<td class="paramname"><em>identifiers</em>, </td>
1210
<td class="paramkey"></td>
1212
<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>
1213
<td class="paramname"><em>removed</em>, </td>
1216
<td class="paramkey"></td>
1218
<td class="paramtype">const <a class="el" href="a00090.html">Tp::CallStateReason</a> & </td>
1219
<td class="paramname"><em>reason</em> </td>
1224
<td></td><td><code> [signal]</code></td>
1228
<div class="memdoc">
1229
<p>Represents the signal <code>CallMembersChanged</code> on the remote object.</p>
1230
<p>Emitted when the CallMembers property changes in any way, either because contacts have been added to the call, contacts have been removed from the call, or contacts' flags have changed.</p>
1231
<dl class="params"><dt><b>Parameters:</b></dt><dd>
1232
<table class="params">
1233
<tr><td class="paramname">flagsChanged</td><td>A map from members of the call to their new call member flags, including at least the members who have been added to CallMembers, and the members whose flags have changed.</td></tr>
1234
<tr><td class="paramname">identifiers</td><td>
1235
The identifiers of the contacts in the <var>Flags_Changed</var> map.
1237
<tr><td class="paramname">removed</td><td>A list of members who have left the call, i.e. keys to be removed from CallMembers.</td></tr>
1238
<tr><td class="paramname">reason</td><td>A structured reason for the change. </td></tr>
1245
<a class="anchor" id="a50f30944805c396ded58589c48eccbdf"></a><!-- doxytag: member="Tp::Client::ChannelTypeCallInterface::invalidate" ref="a50f30944805c396ded58589c48eccbdf" args="(Tp::DBusProxy *, const QString &, const QString &)" -->
1246
<div class="memitem">
1247
<div class="memproto">
1248
<table class="memname">
1250
<td class="memname">void <a class="el" href="a00140.html#a50f30944805c396ded58589c48eccbdf">Tp::Client::ChannelTypeCallInterface::invalidate</a> </td>
1252
<td class="paramtype"><a class="el" href="a00216.html">Tp::DBusProxy</a> * </td>
1253
<td class="paramname"><em>proxy</em>, </td>
1256
<td class="paramkey"></td>
1258
<td class="paramtype">const QString & </td>
1259
<td class="paramname"><em>error</em>, </td>
1262
<td class="paramkey"></td>
1264
<td class="paramtype">const QString & </td>
1265
<td class="paramname"><em>message</em> </td>
1270
<td></td><td><code> [protected, virtual]</code></td>
1274
<div class="memdoc">
1276
<p>Reimplemented from <a class="el" href="a00037.html#a79dde56ba44455f47c7c354ada07467a">Tp::AbstractInterface</a>.</p>
1280
</div><!-- contents -->
1281
<p /><address><hr /><div align="center">
1282
<table width="100%" cellspacing="0" border="0"><tr class="address">
1283
<td width="30%">Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation</td>
1284
<td width="30%" align="right"><div align="right">Telepathy-Qt 0.9.3</div></td>
1285
</tr></table></div></address>
added
removed
doc/html/a00140.html
