Home · All Classes · All Namespaces · Modules · Functions · Files
Signals | Public Member Functions | Static Public Member Functions | List of all members
Tp::ContactMessenger Class Reference

The ContactMessenger class provides an easy way to send text messages to a contact and also track sent/receive text messages from the same contact. More...

#include <TelepathyQt/ContactMessenger>

Inheritance diagram for Tp::ContactMessenger:
Inheritance graph
[legend]

Signals

void messageSent (const Tp::Message &message, Tp::MessageSendingFlags flags, const QString &sentMessageToken, const Tp::TextChannelPtr &channel)
 
void messageReceived (const Tp::ReceivedMessage &message, const Tp::TextChannelPtr &channel)
 

Public Member Functions

virtual ~ContactMessenger ()
 
AccountPtr account () const
 
QString contactIdentifier () const
 
QList< TextChannelPtr > textChats () const
 
PendingSendMessagesendMessage (const QString &text, ChannelTextMessageType type=ChannelTextMessageTypeNormal, MessageSendingFlags flags=0)
 
PendingSendMessagesendMessage (const MessageContentPartList &parts, MessageSendingFlags flags=0)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
virtual  ~QObject ()
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
virtual const QMetaObjectmetaObject () const
 
QString objectName () const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const
 
bool signalsBlocked () const
 
bool blockSignals (bool block)
 
QThreadthread () const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval)
 
void killTimer (int id)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *receiver, const char *method)
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const
 
QList< QByteArraydynamicPropertyNames () const
 
void destroyed (QObject *obj)
 
QObjectparent () const
 
bool inherits (const char *className) const
 
void deleteLater ()
 
 QObject (QObject *parent, const char *name)
 
void insertChild (QObject *object)
 
void removeChild (QObject *object)
 
bool isA (const char *className) const
 
const char * className () const
 
const char * name () const
 
const char * name (const char *defaultName) const
 
void setName (const char *name)
 
- Public Member Functions inherited from Tp::RefCounted
 RefCounted ()
 
virtual ~RefCounted ()
 

Static Public Member Functions

static ContactMessengerPtr create (const AccountPtr &account, const ContactPtr &contact)
 
static ContactMessengerPtr create (const AccountPtr &account, const QString &contactIdentifier)
 
- Static Public Member Functions inherited from QObject
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 

Additional Inherited Members

- Protected Member Functions inherited from QObject
QObjectsender () const
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void disconnectNotify (const char *signal)
 
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

The ContactMessenger class provides an easy way to send text messages to a contact and also track sent/receive text messages from the same contact.

Constructor & Destructor Documentation

Tp::ContactMessenger::~ContactMessenger ( )
virtual

Class destructor.

Member Function Documentation

ContactMessengerPtr Tp::ContactMessenger::create ( const AccountPtr &  account,
const ContactPtr &  contact 
)
static

Create a new ContactMessenger object.

Parameters
accountThe account this messenger is communicating with.
contactThe contact this messenger is communicating with.
Returns
An ContactMessengerPtr object pointing to the newly created ContactMessenger object, or a null ContactMessengerPtr if contact is null.
ContactMessengerPtr Tp::ContactMessenger::create ( const AccountPtr &  account,
const QString contactIdentifier 
)
static

Create a new ContactMessenger object.

Parameters
accountThe account this messenger is communicating with.
contactIdentifierThe identifier of the contact this messenger is communicating with.
Returns
An ContactMessengerPtr object pointing to the newly created ContactMessenger object, or a null ContactMessengerPtr if contact is null.
AccountPtr Tp::ContactMessenger::account ( ) const

Return the account this messenger is communicating with.

Returns
A pointer to the Account object.
QString Tp::ContactMessenger::contactIdentifier ( ) const

Return the identifier of the contact this messenger is communicating with.

Returns
The identifier of the contact.
QList< TextChannelPtr > Tp::ContactMessenger::textChats ( ) const

Return the list of text chats currently being observed.

Returns
A list of pointers to TextChannel objects.
PendingSendMessage * Tp::ContactMessenger::sendMessage ( const QString text,
ChannelTextMessageType  type = ChannelTextMessageTypeNormal,
MessageSendingFlags  flags = 0 
)

Send a message to the contact identified by contactIdentifier() using account().

Note that the return from this method isn't ordered in any sane way, meaning that messageSent() can be signalled either before or after the returned PendingSendMessage object finishes.

Parameters
textThe message text.
typeThe message type.
flagsThe message flags.
Returns
A PendingSendMessage which will emit PendingSendMessage::finished once the reply is received and that can be used to check whether sending the message succeeded or not.
PendingSendMessage * Tp::ContactMessenger::sendMessage ( const MessageContentPartList parts,
MessageSendingFlags  flags = 0 
)

Send a message to the contact identified by contactIdentifier() using account().

Note that the return from this method isn't ordered in any sane way, meaning that messageSent() can be signalled either before or after the returned PendingSendMessage object finishes.

Parameters
partsThe message parts.
flagsThe message flags.
Returns
A PendingSendMessage which will emit PendingSendMessage::finished once the reply is received and that can be used to check whether sending the message succeeded or not.
void Tp::ContactMessenger::messageSent ( const Tp::Message message,
Tp::MessageSendingFlags  flags,
const QString sentMessageToken,
const Tp::TextChannelPtr &  channel 
)
signal

Emitted whenever a text message on account() is sent to the contact identified by contactIdentifier().

Parameters
messageThe message sent.
flagsThe flags of the message that was sent.
sentMessageTokenThe token of the message that was sent.
channelThe channel from which the message was sent.
void Tp::ContactMessenger::messageReceived ( const Tp::ReceivedMessage message,
const Tp::TextChannelPtr &  channel 
)
signal

Emitted whenever a text message on account() is received from the contact identified by contactIdentifier().

Parameters
messageThe message received.
channelThe channel from which the message was received.


Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation
Telepathy-Qt 0.9.4