1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>TelepathyQt4: Tp::PendingChannel Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="1"> </td>
<td class="postheader" valign="center">
<a href="index.html">
<font color="#004faf">Home</font></a> ·
<a href="classes.html">
<font color="#004faf">All Classes</font></a> ·
<a href="namespaces.html">
<font color="#004faf">All Namespaces</font></a> ·
<a href="modules.html">
<font color="#004faf">Modules</font></a> ·
<a href="functions.html">
<font color="#004faf">Functions</font></a> ·
<a href="files.html">
<font color="#004faf">Files</font></a>
</td>
</tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navpath"><a class="el" href="namespaceTp.html">Tp</a>::<a class="el" href="classTp_1_1PendingChannel.html">PendingChannel</a>
</div>
<div class="contents">
<h1>Tp::PendingChannel Class Reference<br/>
<small>
[<a class="el" href="group__clientchannel.html">Channel proxies</a>]</small>
</h1><!-- doxytag: class="Tp::PendingChannel" --><!-- doxytag: inherits="Tp::PendingOperation" -->
<p>Class containing the parameters of and the reply to an asynchronous channel request. Instances of this class cannot be constructed directly; the only way to get one is trough <a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a>.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="pending-channel_8h_source.html">TelepathyQt4/PendingChannel</a>></code></p>
<p>Inherits <a class="el" href="classTp_1_1PendingOperation.html">Tp::PendingOperation</a>.</p>
<p><a href="classTp_1_1PendingChannel-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1PendingChannel.html#ae77602d6533a88ff261daa51cebd9c55">~PendingChannel</a> ()
<li><a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> <a class="el" href="classTp_1_1PendingChannel.html#ad3b1c8a68ce7999d2457bd7fa2536a81">connection</a> () const
<li>bool <a class="el" href="classTp_1_1PendingChannel.html#a19aec0edcb732c12eddd2b388a11c94e">yours</a> () const
<li>const QString & <a class="el" href="classTp_1_1PendingChannel.html#ac46b44e368b45f274b43625c48ae76ba">channelType</a> () const
<li>uint <a class="el" href="classTp_1_1PendingChannel.html#ad99154ee5c89e62e02341f688d54e05d">targetHandleType</a> () const
<li>uint <a class="el" href="classTp_1_1PendingChannel.html#abc8e08deea949fec59591954c4375ac2">targetHandle</a> () const
<li>QVariantMap <a class="el" href="classTp_1_1PendingChannel.html#a8b2b2ea1c7d4c201ee3125e143372e14">immutableProperties</a> () const
<li><a class="el" href="classTp_1_1SharedPtr.html">ChannelPtr</a> <a class="el" href="classTp_1_1PendingChannel.html#a11fb7e7f32712a4f9a25aaf59687d2cb">channel</a> () const
<li>QString <a class="el" href="classTp_1_1PendingChannel.html#ac4e6d6cfc06fcc02764a5275e02200b5">objectPath</a> () const
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class containing the parameters of and the reply to an asynchronous channel request. Instances of this class cannot be constructed directly; the only way to get one is trough <a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a>. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae77602d6533a88ff261daa51cebd9c55"></a><!-- doxytag: member="Tp::PendingChannel::~PendingChannel" ref="ae77602d6533a88ff261daa51cebd9c55" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::PendingChannel::~PendingChannel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad3b1c8a68ce7999d2457bd7fa2536a81"></a><!-- doxytag: member="Tp::PendingChannel::connection" ref="ad3b1c8a68ce7999d2457bd7fa2536a81" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> Tp::PendingChannel::connection </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the <a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a> object through which the channel request was made.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the <a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a19aec0edcb732c12eddd2b388a11c94e"></a><!-- doxytag: member="Tp::PendingChannel::yours" ref="a19aec0edcb732c12eddd2b388a11c94e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::PendingChannel::yours </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this channel belongs to this process.</p>
<p>If false, the caller MUST assume that some other process is handling this channel; if true, the caller SHOULD handle it themselves or delegate it to another client.</p>
<p>Note that the value is undefined until the operation finishes.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Boolean indicating whether this channel belongs to this process. </dd></dl>
</div>
</div>
<a class="anchor" id="ac46b44e368b45f274b43625c48ae76ba"></a><!-- doxytag: member="Tp::PendingChannel::channelType" ref="ac46b44e368b45f274b43625c48ae76ba" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const QString & Tp::PendingChannel::channelType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the channel type specified in the channel request.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The D-Bus interface name of the interface specific to the requested channel type. </dd></dl>
</div>
</div>
<a class="anchor" id="ad99154ee5c89e62e02341f688d54e05d"></a><!-- doxytag: member="Tp::PendingChannel::targetHandleType" ref="ad99154ee5c89e62e02341f688d54e05d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint Tp::PendingChannel::targetHandleType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the channel request has finished, return the handle type of the resulting channel. Otherwise, return the handle type that was requested.</p>
<p>(One example of a request producing a different target handle type is that on protocols like MSN, one-to-one conversations don't really exist, and if you request a text channel with handle type HandleTypeContact, what you will actually get is a text channel with handle type HandleTypeNone, with the requested contact as a member.)</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The handle type, as specified in HandleType. </dd></dl>
</div>
</div>
<a class="anchor" id="abc8e08deea949fec59591954c4375ac2"></a><!-- doxytag: member="Tp::PendingChannel::targetHandle" ref="abc8e08deea949fec59591954c4375ac2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint Tp::PendingChannel::targetHandle </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the channel request has finished, return the target handle of the resulting channel. Otherwise, return the target handle that was requested (which might be different in some situations - see targetHandleType).</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The handle. </dd></dl>
</div>
</div>
<a class="anchor" id="a8b2b2ea1c7d4c201ee3125e143372e14"></a><!-- doxytag: member="Tp::PendingChannel::immutableProperties" ref="a8b2b2ea1c7d4c201ee3125e143372e14" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QVariantMap Tp::PendingChannel::immutableProperties </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If this channel request has finished, return the immutable properties of the resulting channel. Otherwise, return an empty map.</p>
<p>The keys and values in this map are defined by the Telepathy D-Bus specification, or by third-party extensions to that specification. These are the properties that cannot change over the lifetime of the channel; they're announced in the result of the request, for efficiency. This map should be passed to the constructor of <a class="el" href="classTp_1_1Channel.html" title="The Channel class provides an object representing a Telepathy channel.">Channel</a> or its subclasses (such as <a class="el" href="classTp_1_1TextChannel.html" title="The TextChannel class provides an object representing a Telepathy channel of type...">TextChannel</a>).</p>
<p>These properties can also be used to process channels in a way that does not require the creation of a <a class="el" href="classTp_1_1Channel.html" title="The Channel class provides an object representing a Telepathy channel.">Channel</a> object - for instance, a ChannelDispatcher implementation should be able to classify and process channels based on their immutable properties, without needing to create <a class="el" href="classTp_1_1Channel.html" title="The Channel class provides an object representing a Telepathy channel.">Channel</a> objects.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A map in which the keys are D-Bus property names and the values are the corresponding values. </dd></dl>
</div>
</div>
<a class="anchor" id="a11fb7e7f32712a4f9a25aaf59687d2cb"></a><!-- doxytag: member="Tp::PendingChannel::channel" ref="a11fb7e7f32712a4f9a25aaf59687d2cb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1SharedPtr.html">ChannelPtr</a> Tp::PendingChannel::channel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a shared pointer to a <a class="el" href="classTp_1_1Channel.html" title="The Channel class provides an object representing a Telepathy channel.">Channel</a> high-level proxy object associated with the remote channel resulting from the channel request. If <a class="el" href="classTp_1_1PendingOperation.html#a2b4e8575ad69c45cba0b2b070674c51f">isValid()</a> returns <code>false</code>, the request has not (at least yet) completed successfully, and a null ChannelPtr will be returned.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Shared pointer to the new <a class="el" href="classTp_1_1Channel.html" title="The Channel class provides an object representing a Telepathy channel.">Channel</a> object, 0 if an error occurred. </dd></dl>
</div>
</div>
<a class="anchor" id="ac4e6d6cfc06fcc02764a5275e02200b5"></a><!-- doxytag: member="Tp::PendingChannel::objectPath" ref="ac4e6d6cfc06fcc02764a5275e02200b5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Tp::PendingChannel::objectPath </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the channel object path or an empty string on error.</p>
<p>This method is useful for creating custom <a class="el" href="classTp_1_1Channel.html" title="The Channel class provides an object representing a Telepathy channel.">Channel</a> objects, so instead of using <a class="el" href="classTp_1_1PendingChannel.html#a11fb7e7f32712a4f9a25aaf59687d2cb">PendingChannel::channel</a>, one could construct a new custom channel with the object path.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classTp_1_1Channel.html" title="The Channel class provides an object representing a Telepathy channel.">Channel</a> object path. </dd></dl>
</div>
</div>
</div>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright © 2008-2010 Collabora Ltd. and Nokia Corporation</td>
<td width="30%" align="right"><div align="right">Telepathy-Qt4 0.3.6</div></td>
</tr></table></div></address>
</body>
</html>
|
