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
|
<?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::IncomingFileTransferChannel 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_1IncomingFileTransferChannel.html">IncomingFileTransferChannel</a>
</div>
<div class="contents">
<h1>Tp::IncomingFileTransferChannel Class Reference<br/>
<small>
[<a class="el" href="group__clientchannel.html">Channel proxies</a>]</small>
</h1><!-- doxytag: class="Tp::IncomingFileTransferChannel" --><!-- doxytag: inherits="Tp::FileTransferChannel" -->
<p>The <a class="el" href="classTp_1_1IncomingFileTransferChannel.html" title="The IncomingFileTransferChannel class provides an object representing a Telepathy...">IncomingFileTransferChannel</a> class provides an object representing a Telepathy channel of type FileTransfer for incoming file transfers.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="incoming-file-transfer-channel_8h_source.html">TelepathyQt4/IncomingFileTransferChannel</a>></code></p>
<p>Inherits <a class="el" href="classTp_1_1FileTransferChannel.html">Tp::FileTransferChannel</a>.</p>
<p><a href="classTp_1_1IncomingFileTransferChannel-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li>virtual <a class="el" href="classTp_1_1IncomingFileTransferChannel.html#a15b6bb0c0d092a524cc0bbdfb321766a">~IncomingFileTransferChannel</a> ()
<li><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * <a class="el" href="classTp_1_1IncomingFileTransferChannel.html#aa62e022018986504a09f1f74172c991d">acceptFile</a> (qulonglong offset, QIODevice *output)
</ul>
<h2>Static Public Member Functions</h2>
<ul>
<li>static <br class="typebreak"/>
<a class="el" href="classTp_1_1SharedPtr.html">IncomingFileTransferChannelPtr</a> <a class="el" href="classTp_1_1IncomingFileTransferChannel.html#aafd81dd707b1d9c150e3ff21f93d9b2f">create</a> (const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &connection, const QString &objectPath, const QVariantMap &immutableProperties)
</ul>
<h2>Static Public Attributes</h2>
<ul>
<li>static const <a class="el" href="classTp_1_1Feature.html">Feature</a> <a class="el" href="classTp_1_1IncomingFileTransferChannel.html#acfa3edfc8e92758318b00454b6efd946">FeatureCore</a>
</ul>
<h2>Protected Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1IncomingFileTransferChannel.html#ac1ad2fd01637a495936e41717355dcb3">IncomingFileTransferChannel</a> (const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &connection, const QString &objectPath, const QVariantMap &immutableProperties)
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classTp_1_1IncomingFileTransferChannel.html" title="The IncomingFileTransferChannel class provides an object representing a Telepathy...">IncomingFileTransferChannel</a> class provides an object representing a Telepathy channel of type FileTransfer for incoming file transfers. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a15b6bb0c0d092a524cc0bbdfb321766a"></a><!-- doxytag: member="Tp::IncomingFileTransferChannel::~IncomingFileTransferChannel" ref="a15b6bb0c0d092a524cc0bbdfb321766a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::IncomingFileTransferChannel::~IncomingFileTransferChannel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class destructor. </p>
</div>
</div>
<a class="anchor" id="ac1ad2fd01637a495936e41717355dcb3"></a><!-- doxytag: member="Tp::IncomingFileTransferChannel::IncomingFileTransferChannel" ref="ac1ad2fd01637a495936e41717355dcb3" args="(const ConnectionPtr &connection, const QString &objectPath, const QVariantMap &immutableProperties)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::IncomingFileTransferChannel::IncomingFileTransferChannel </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> & </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>objectPath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariantMap & </td>
<td class="paramname"> <em>immutableProperties</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a new IncomingFileTransfer channel.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td><a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a> owning this channel, and specifying the service. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>objectPath</em> </td><td>The object path of this channel. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>immutableProperties</em> </td><td>The immutable properties of this channel. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aafd81dd707b1d9c150e3ff21f93d9b2f"></a><!-- doxytag: member="Tp::IncomingFileTransferChannel::create" ref="aafd81dd707b1d9c150e3ff21f93d9b2f" args="(const ConnectionPtr &connection, const QString &objectPath, const QVariantMap &immutableProperties)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1SharedPtr.html">IncomingFileTransferChannelPtr</a> Tp::IncomingFileTransferChannel::create </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> & </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>objectPath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariantMap & </td>
<td class="paramname"> <em>immutableProperties</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new InconmingFileTransferChannel object.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td><a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a> owning this channel, and specifying the service. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>objectPath</em> </td><td>The object path of this channel. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>immutableProperties</em> </td><td>The immutable properties of this channel. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A StreamedMediaChannelPtr object pointing to the newly created <a class="el" href="classTp_1_1StreamedMediaChannel.html" title="The StreamedMediaChannel class provides an object representing a Telepathy channel...">StreamedMediaChannel</a> object. </dd></dl>
<p>Reimplemented from <a class="el" href="classTp_1_1FileTransferChannel.html#abc5e5967f512675521c323b480bae955">Tp::FileTransferChannel</a>.</p>
</div>
</div>
<a class="anchor" id="aa62e022018986504a09f1f74172c991d"></a><!-- doxytag: member="Tp::IncomingFileTransferChannel::acceptFile" ref="aa62e022018986504a09f1f74172c991d" args="(qulonglong offset, QIODevice *output)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * Tp::IncomingFileTransferChannel::acceptFile </td>
<td>(</td>
<td class="paramtype">qulonglong </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QIODevice * </td>
<td class="paramname"> <em>output</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Accept a file transfer that's in the FileTransferStatePending <a class="el" href="classTp_1_1FileTransferChannel.html#af5eaf95fce467175709bc9a677a99823">state()</a>. The state will change to FileTransferStateOpen as soon as the transfer starts. The given output device should not be closed/destroyed until the <a class="el" href="classTp_1_1FileTransferChannel.html#af5eaf95fce467175709bc9a677a99823">state()</a> changes to FileTransferStateCompleted or FileTransferStateCancelled.</p>
<p>Only the primary handler of a file transfer channel may call this method.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>The desired offset in bytes where the file transfer should start. The offset is taken from the beginning of the file. Specifying an offset of zero will start the transfer from the beginning of the file. The offset that is actually given in the <a class="el" href="classTp_1_1FileTransferChannel.html#a34dbec4a30c0d73d1f8861a3500af57d">initialOffset()</a> method can differ from this argument where the requested offset is not supported. (For example, some protocols do not support offsets at all so the <a class="el" href="classTp_1_1FileTransferChannel.html#a34dbec4a30c0d73d1f8861a3500af57d">initialOffset()</a> will always be 0.). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>A QIODevice object where the data will be written to. The device should be ready to use when the <a class="el" href="classTp_1_1FileTransferChannel.html#af5eaf95fce467175709bc9a677a99823">state()</a> changes to FileTransferStateCompleted. If the transfer is cancelled, <a class="el" href="classTp_1_1FileTransferChannel.html#af5eaf95fce467175709bc9a677a99823">state()</a> becomes FileTransferStateCancelled, the data in <em>output</em> should be ignored </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> object which will emit <a class="el" href="classTp_1_1PendingOperation.html#addbb8c4462019ffdf19095a31da0cc7a">PendingOperation::finished</a> when the call has finished. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1FileTransferChannel.html#ae7bab5a3817ce7c036509b3548c59d8b">stateChanged()</a>, <a class="el" href="classTp_1_1FileTransferChannel.html#af5eaf95fce467175709bc9a677a99823">state()</a>, <a class="el" href="classTp_1_1FileTransferChannel.html#a60f72666dfef89e088ae3a0b0f48f74d">stateReason()</a>, <a class="el" href="classTp_1_1FileTransferChannel.html#a34dbec4a30c0d73d1f8861a3500af57d">initialOffset()</a> </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="acfa3edfc8e92758318b00454b6efd946"></a><!-- doxytag: member="Tp::IncomingFileTransferChannel::FeatureCore" ref="acfa3edfc8e92758318b00454b6efd946" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTp_1_1Feature.html">Feature</a> <a class="el" href="classTp_1_1IncomingFileTransferChannel.html#acfa3edfc8e92758318b00454b6efd946">Tp::IncomingFileTransferChannel::FeatureCore</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classTp_1_1Feature.html">Feature</a> representing the core that needs to become ready to make the <a class="el" href="classTp_1_1IncomingFileTransferChannel.html" title="The IncomingFileTransferChannel class provides an object representing a Telepathy...">IncomingFileTransferChannel</a> object usable.</p>
<p>Note that this feature must be enabled in order to use most <a class="el" href="classTp_1_1IncomingFileTransferChannel.html" title="The IncomingFileTransferChannel class provides an object representing a Telepathy...">IncomingFileTransferChannel</a> methods. See specific methods documentation for more details.</p>
<p>When calling <a class="el" href="classTp_1_1ReadyObject.html#a344fc63eaef5278cbf938eaa1ed4c635">isReady()</a>, <a class="el" href="classTp_1_1ReadyObject.html#ac02393f99a46725a4ffee32caaec13cc">becomeReady()</a>, this feature is implicitly added to the requested features. </p>
<p>Reimplemented from <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">Tp::FileTransferChannel</a>.</p>
</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>
|
