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
|
<?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::ReceivedMessage 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_1ReceivedMessage.html">ReceivedMessage</a>
</div>
<div class="contents">
<h1>Tp::ReceivedMessage Class Reference<br/>
<small>
[<a class="el" href="group__clientchannel.html">Channel proxies</a>]</small>
</h1><!-- doxytag: class="Tp::ReceivedMessage" --><!-- doxytag: inherits="Tp::Message" -->
<p>The <a class="el" href="classTp_1_1ReceivedMessage.html" title="The ReceivedMessage class is a subclass of Message, representing a received message...">ReceivedMessage</a> class is a subclass of <a class="el" href="classTp_1_1Message.html" title="The Message class represents a Telepathy message in a text channel. These objects...">Message</a>, representing a received message.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="message_8h_source.html">TelepathyQt4/TextChannel</a>></code></p>
<p>Inherits <a class="el" href="classTp_1_1Message.html">Tp::Message</a>.</p>
<p><a href="classTp_1_1ReceivedMessage-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1ReceivedMessage.html#ac9c8a6c2de8f85e3497ae55763b2666d">ReceivedMessage</a> (const <a class="el" href="classTp_1_1ReceivedMessage.html">ReceivedMessage</a> &other)
<li><a class="el" href="classTp_1_1ReceivedMessage.html">ReceivedMessage</a> & <a class="el" href="classTp_1_1ReceivedMessage.html#a3e813666af59e9498543662a1bfcc3d6">operator=</a> (const <a class="el" href="classTp_1_1ReceivedMessage.html">ReceivedMessage</a> &other)
<li><a class="el" href="classTp_1_1ReceivedMessage.html#a89ac72b35d58e961d4e3d8e110d9849b">~ReceivedMessage</a> ()
<li>QDateTime <a class="el" href="classTp_1_1ReceivedMessage.html#ae9457ab365ace5059be01881d8382891">received</a> () const
<li><a class="el" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">ContactPtr</a> <a class="el" href="classTp_1_1ReceivedMessage.html#a651d3313775c1796b7fb17459eb6796e">sender</a> () const
<li>bool <a class="el" href="classTp_1_1ReceivedMessage.html#af57030d9d5b0e0ded2cbea4c1cc1c03f">isScrollback</a> () const
<li>bool <a class="el" href="classTp_1_1ReceivedMessage.html#a58bbb6f3c9bfc3c941f316e4e89aaa58">isRescued</a> () const
<li>bool <a class="el" href="classTp_1_1ReceivedMessage.html#aa18322677acc4e0f8600cfe1c36b0e1e">isFromChannel</a> (const <a class="el" href="classTp_1_1SharedPtr.html">TextChannelPtr</a> &channel) const
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classTp_1_1ReceivedMessage.html" title="The ReceivedMessage class is a subclass of Message, representing a received message...">ReceivedMessage</a> class is a subclass of <a class="el" href="classTp_1_1Message.html" title="The Message class represents a Telepathy message in a text channel. These objects...">Message</a>, representing a received message. </p>
<p>It contains additional information that's generally only available on received messages. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac9c8a6c2de8f85e3497ae55763b2666d"></a><!-- doxytag: member="Tp::ReceivedMessage::ReceivedMessage" ref="ac9c8a6c2de8f85e3497ae55763b2666d" args="(const ReceivedMessage &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::ReceivedMessage::ReceivedMessage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTp_1_1ReceivedMessage.html">ReceivedMessage</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="a89ac72b35d58e961d4e3d8e110d9849b"></a><!-- doxytag: member="Tp::ReceivedMessage::~ReceivedMessage" ref="a89ac72b35d58e961d4e3d8e110d9849b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::ReceivedMessage::~ReceivedMessage </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3e813666af59e9498543662a1bfcc3d6"></a><!-- doxytag: member="Tp::ReceivedMessage::operator=" ref="a3e813666af59e9498543662a1bfcc3d6" args="(const ReceivedMessage &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1ReceivedMessage.html">ReceivedMessage</a> & Tp::ReceivedMessage::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTp_1_1ReceivedMessage.html">ReceivedMessage</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="ae9457ab365ace5059be01881d8382891"></a><!-- doxytag: member="Tp::ReceivedMessage::received" ref="ae9457ab365ace5059be01881d8382891" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QDateTime Tp::ReceivedMessage::received </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 received.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A timestamp </dd></dl>
</div>
</div>
<a class="anchor" id="a651d3313775c1796b7fb17459eb6796e"></a><!-- doxytag: member="Tp::ReceivedMessage::sender" ref="a651d3313775c1796b7fb17459eb6796e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">ContactPtr</a> Tp::ReceivedMessage::sender </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_1Contact.html">Contact</a> who sent the message, or ContactPtr(0) if unknown.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The sender or ContactPtr(0) </dd></dl>
</div>
</div>
<a class="anchor" id="af57030d9d5b0e0ded2cbea4c1cc1c03f"></a><!-- doxytag: member="Tp::ReceivedMessage::isScrollback" ref="af57030d9d5b0e0ded2cbea4c1cc1c03f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::ReceivedMessage::isScrollback </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether the incoming message was part of a replay of message history.</p>
<p>If true, loggers can use this to improve their heuristics for elimination of duplicate messages (a simple, correct implementation would be to avoid logging any message that has this flag).</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>whether the scrollback flag is set </dd></dl>
</div>
</div>
<a class="anchor" id="a58bbb6f3c9bfc3c941f316e4e89aaa58"></a><!-- doxytag: member="Tp::ReceivedMessage::isRescued" ref="a58bbb6f3c9bfc3c941f316e4e89aaa58" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::ReceivedMessage::isRescued </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether the incoming message was seen in a previous channel during the lifetime of this <a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a>, but was not acknowledged before that chanenl closed, causing the channel in which it now appears to open.</p>
<p>If true, loggers should not log this message again.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>whether the rescued flag is set </dd></dl>
</div>
</div>
<a class="anchor" id="aa18322677acc4e0f8600cfe1c36b0e1e"></a><!-- doxytag: member="Tp::ReceivedMessage::isFromChannel" ref="aa18322677acc4e0f8600cfe1c36b0e1e" args="(const TextChannelPtr &channel) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::ReceivedMessage::isFromChannel </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTp_1_1SharedPtr.html">TextChannelPtr</a> & </td>
<td class="paramname"> <em>channel</em></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>
|