Telepathy::Client::ReceivedMessage Class Reference
[Channel proxies]

#include <TelepathyQt4/Client/TextChannel>

Inheritance diagram for Telepathy::Client::ReceivedMessage:

Inheritance graph
[legend]
Collaboration diagram for Telepathy::Client::ReceivedMessage:

Collaboration graph
[legend]

List of all members.


Detailed Description

Subclass of Message, with additional information that's generally only available on received messages.

Public Member Functions

 ReceivedMessage (const ReceivedMessage &other)
ReceivedMessageoperator= (const ReceivedMessage &other)
 ~ReceivedMessage ()
QDateTime received () const
QSharedPointer< Contactsender () const
bool isScrollback () const
bool isRescued () const
bool isFromChannel (const TextChannel *channel) const

Friends

class TextChannel

Constructor & Destructor Documentation

Telepathy::Client::ReceivedMessage::ReceivedMessage ( const ReceivedMessage other  ) 

Copy constructor.

Telepathy::Client::ReceivedMessage::~ReceivedMessage (  ) 

Destructor.


Member Function Documentation

ReceivedMessage & Telepathy::Client::ReceivedMessage::operator= ( const ReceivedMessage other  ) 

Assignment operator.

QDateTime Telepathy::Client::ReceivedMessage::received (  )  const

Return the time the message was received.

Returns:
A timestamp

QSharedPointer< Contact > Telepathy::Client::ReceivedMessage::sender (  )  const

Return the Contact who sent the message, or QSharedPointer<Contact>(0) if unknown.

Returns:
The sender or QSharedPointer<Contact>(0)

bool Telepathy::Client::ReceivedMessage::isScrollback (  )  const

Return whether the incoming message was part of a replay of message history.

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).

Returns:
whether the scrollback flag is set

bool Telepathy::Client::ReceivedMessage::isRescued (  )  const

Return whether the incoming message was seen in a previous channel during the lifetime of this Connection, but was not acknowledged before that chanenl closed, causing the channel in which it now appears to open.

If true, loggers should not log this message again.

Returns:
whether the rescued flag is set

bool Telepathy::Client::ReceivedMessage::isFromChannel ( const TextChannel channel  )  const


Friends And Related Function Documentation

friend class TextChannel [friend]

Reimplemented from Telepathy::Client::Message.


Generated on Fri Feb 27 12:10:28 2009 for TelepathyQt4-0.1.0 by  doxygen 1.5.6