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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
|
<?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::Message 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_1Message.html">Message</a>
</div>
<div class="contents">
<h1>Tp::Message Class Reference<br/>
<small>
[<a class="el" href="group__clientchannel.html">Channel proxies</a>]</small>
</h1><!-- doxytag: class="Tp::Message" -->
<p>The <a class="el" href="classTp_1_1Message.html" title="The Message class represents a Telepathy message in a text channel. These objects...">Message</a> class represents a Telepathy message in a text channel. These objects are implicitly shared, like QString.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="message_8h_source.html">TelepathyQt4/TextChannel</a>></code></p>
<p>Inherited by <a class="el" href="classTp_1_1ReceivedMessage.html">Tp::ReceivedMessage</a>.</p>
<p><a href="classTp_1_1Message-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1Message.html#a613729fbb1dd2e2a8280c0218055ca9c">Message</a> (ChannelTextMessageType, const QString &)
<li><a class="el" href="classTp_1_1Message.html#a12ad1f6c77609ba2cd3d3d081c3c8d25">Message</a> (const <a class="el" href="classTp_1_1Message.html">Message</a> &other)
<li><a class="el" href="classTp_1_1Message.html#aef167f02f084bb4950fe5daf855281c8">~Message</a> ()
<li><a class="el" href="classTp_1_1Message.html">Message</a> & <a class="el" href="classTp_1_1Message.html#a5688d85413d3be1c03d4db54e80dcc9e">operator=</a> (const <a class="el" href="classTp_1_1Message.html">Message</a> &other)
<li>bool <a class="el" href="classTp_1_1Message.html#aae5944d0f2387b9a5e4d205a57d2f31a">operator==</a> (const <a class="el" href="classTp_1_1Message.html">Message</a> &other) const
<li>bool <a class="el" href="classTp_1_1Message.html#ab44f1b185f23f41795e7bfc29c6d4ac1">operator!=</a> (const <a class="el" href="classTp_1_1Message.html">Message</a> &other) const
<li>QDateTime <a class="el" href="classTp_1_1Message.html#a50b3c6c7a03d2c2f132915b9087c0a19">sent</a> () const
<li>ChannelTextMessageType <a class="el" href="classTp_1_1Message.html#ab17c74b432798fa117369cb88a67ea61">messageType</a> () const
<li>bool <a class="el" href="classTp_1_1Message.html#aaa663a7149c35528f19b997f83c65601">isTruncated</a> () const
<li>bool <a class="el" href="classTp_1_1Message.html#afe7b6f02defee51318d53c1630e218f7">hasNonTextContent</a> () const
<li>QString <a class="el" href="classTp_1_1Message.html#a61584c03abf795aea21205f50ec81bfa">messageToken</a> () const
<li>bool <a class="el" href="classTp_1_1Message.html#aab23c41b78a78d35ad921ad5a53fc975">isSpecificToDBusInterface</a> () const
<li>QString <a class="el" href="classTp_1_1Message.html#ae18bd32e2fb4437345f247bb29e63043">dbusInterface</a> () const
<li>QString <a class="el" href="classTp_1_1Message.html#a7707a341dabe4ee5f99fc0247d891fe6">text</a> () const
<li>MessagePart <a class="el" href="classTp_1_1Message.html#a7fe6f84f66c787956723f04ab92c808a">header</a> () const
<li>int <a class="el" href="classTp_1_1Message.html#ae50f4914b58c68fa4f78378047b4ea3f">size</a> () const
<li>MessagePart <a class="el" href="classTp_1_1Message.html#a6162eee67ff8d4bfb3707c52bdac93ba">part</a> (uint index) const
<li>MessagePartList <a class="el" href="classTp_1_1Message.html#ab259a109bc86cf1435a63374ac3fb29c">parts</a> () const
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classTp_1_1Message.html" title="The Message class represents a Telepathy message in a text channel. These objects...">Message</a> class represents a Telepathy message in a text channel. These objects are implicitly shared, like QString. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a613729fbb1dd2e2a8280c0218055ca9c"></a><!-- doxytag: member="Tp::Message::Message" ref="a613729fbb1dd2e2a8280c0218055ca9c" args="(ChannelTextMessageType, const QString &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::Message::Message </td>
<td>(</td>
<td class="paramtype">ChannelTextMessageType </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>text</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor, from the parameters of the old Send method.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>The message type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>The text of the message </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a12ad1f6c77609ba2cd3d3d081c3c8d25"></a><!-- doxytag: member="Tp::Message::Message" ref="a12ad1f6c77609ba2cd3d3d081c3c8d25" args="(const Message &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::Message::Message </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTp_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
</div>
</div>
<a class="anchor" id="aef167f02f084bb4950fe5daf855281c8"></a><!-- doxytag: member="Tp::Message::~Message" ref="aef167f02f084bb4950fe5daf855281c8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::Message::~Message </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="a5688d85413d3be1c03d4db54e80dcc9e"></a><!-- doxytag: member="Tp::Message::operator=" ref="a5688d85413d3be1c03d4db54e80dcc9e" args="(const Message &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1Message.html">Message</a> & Tp::Message::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTp_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator. </p>
</div>
</div>
<a class="anchor" id="aae5944d0f2387b9a5e4d205a57d2f31a"></a><!-- doxytag: member="Tp::Message::operator==" ref="aae5944d0f2387b9a5e4d205a57d2f31a" args="(const Message &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::Message::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTp_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Equality operator. </p>
</div>
</div>
<a class="anchor" id="ab44f1b185f23f41795e7bfc29c6d4ac1"></a><!-- doxytag: member="Tp::Message::operator!=" ref="ab44f1b185f23f41795e7bfc29c6d4ac1" args="(const Message &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::Message::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTp_1_1Message.html">Message</a> & </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a50b3c6c7a03d2c2f132915b9087c0a19"></a><!-- doxytag: member="Tp::Message::sent" ref="a50b3c6c7a03d2c2f132915b9087c0a19" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QDateTime Tp::Message::sent </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the time the message was sent, or QDateTime() if that time is unknown.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A timestamp </dd></dl>
</div>
</div>
<a class="anchor" id="ab17c74b432798fa117369cb88a67ea61"></a><!-- doxytag: member="Tp::Message::messageType" ref="ab17c74b432798fa117369cb88a67ea61" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ChannelTextMessageType Tp::Message::messageType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the type of message this is, or ChannelTextMessageTypeNormal if the type is not recognised.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The ChannelTextMessageType for this message </dd></dl>
</div>
</div>
<a class="anchor" id="aaa663a7149c35528f19b997f83c65601"></a><!-- doxytag: member="Tp::Message::isTruncated" ref="aaa663a7149c35528f19b997f83c65601" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::Message::isTruncated </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this message was truncated during delivery. </p>
</div>
</div>
<a class="anchor" id="afe7b6f02defee51318d53c1630e218f7"></a><!-- doxytag: member="Tp::Message::hasNonTextContent" ref="afe7b6f02defee51318d53c1630e218f7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::Message::hasNonTextContent </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this message contains parts not representable as plain text.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this message cannot completely be represented as plain text </dd></dl>
</div>
</div>
<a class="anchor" id="a61584c03abf795aea21205f50ec81bfa"></a><!-- doxytag: member="Tp::Message::messageToken" ref="a61584c03abf795aea21205f50ec81bfa" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Tp::Message::messageToken </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the unique token identifying this message (e.g. the id attribute for XMPP messages), or an empty string if there is no suitable token.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A non-empty message identifier, or an empty string if none </dd></dl>
</div>
</div>
<a class="anchor" id="aab23c41b78a78d35ad921ad5a53fc975"></a><!-- doxytag: member="Tp::Message::isSpecificToDBusInterface" ref="aab23c41b78a78d35ad921ad5a53fc975" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::Message::isSpecificToDBusInterface </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this message is specific to a D-Bus interface. This is false in almost all cases.</p>
<p>If this function returns true, the message is specific to the interface indicated by dbusInterface. Clients that don't understand that interface should not display the message. However, if the client would acknowledge an ordinary message, it must also acknowledge this interface-specific message.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if dbusInterface would return a non-empty string </dd></dl>
</div>
</div>
<a class="anchor" id="ae18bd32e2fb4437345f247bb29e63043"></a><!-- doxytag: member="Tp::Message::dbusInterface" ref="ae18bd32e2fb4437345f247bb29e63043" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Tp::Message::dbusInterface </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the D-Bus interface to which this message is specific, or an empty string for normal messages. </p>
</div>
</div>
<a class="anchor" id="a7707a341dabe4ee5f99fc0247d891fe6"></a><!-- doxytag: member="Tp::Message::text" ref="a7707a341dabe4ee5f99fc0247d891fe6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Tp::Message::text </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7fe6f84f66c787956723f04ab92c808a"></a><!-- doxytag: member="Tp::Message::header" ref="a7fe6f84f66c787956723f04ab92c808a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MessagePart Tp::Message::header </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the message's header part, as defined by the Telepathy D-Bus API specification. This is provided for advanced clients that need to access additional information not available through the normal <a class="el" href="classTp_1_1Message.html" title="The Message class represents a Telepathy message in a text channel. These objects...">Message</a> API.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The same thing as messagepart(0) </dd></dl>
</div>
</div>
<a class="anchor" id="ae50f4914b58c68fa4f78378047b4ea3f"></a><!-- doxytag: member="Tp::Message::size" ref="ae50f4914b58c68fa4f78378047b4ea3f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Tp::Message::size </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the number of parts in this message.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 greater than the largest valid argument to part </dd></dl>
</div>
</div>
<a class="anchor" id="a6162eee67ff8d4bfb3707c52bdac93ba"></a><!-- doxytag: member="Tp::Message::part" ref="a6162eee67ff8d4bfb3707c52bdac93ba" args="(uint index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MessagePart Tp::Message::part </td>
<td>(</td>
<td class="paramtype">uint </td>
<td class="paramname"> <em>index</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the message's header part, as defined by the Telepathy D-Bus API specification. This is provided for advanced clients that need to access additional information not available through the normal <a class="el" href="classTp_1_1Message.html" title="The Message class represents a Telepathy message in a text channel. These objects...">Message</a> API.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>The part to access, which must be strictly less than <a class="el" href="classTp_1_1Message.html#ae50f4914b58c68fa4f78378047b4ea3f">size()</a>; part number 0 is the header, parts numbered 1 or greater are the body of the message. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Part of the message </dd></dl>
</div>
</div>
<a class="anchor" id="ab259a109bc86cf1435a63374ac3fb29c"></a><!-- doxytag: member="Tp::Message::parts" ref="ab259a109bc86cf1435a63374ac3fb29c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MessagePartList Tp::Message::parts </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</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>
|
