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>

Inherits QObject, and Tp::RefCounted.

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
PendingSendMessage *	sendMessage (const QString &text, ChannelTextMessageType type=ChannelTextMessageTypeNormal, MessageSendingFlags flags=0)
PendingSendMessage *	sendMessage (const MessageContentPartList &parts, MessageSendingFlags flags=0)
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)

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

~ContactMessenger()

Tp::ContactMessenger::~ContactMessenger ( )

virtual

Class destructor.

Member Function Documentation

create() [1/2]

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

static

Create a new ContactMessenger object.

Parameters

account	The account this messenger is communicating with.
contact	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.

create() [2/2]

ContactMessengerPtr Tp::ContactMessenger::create ( const AccountPtr &  account, const QString &  contactIdentifier  )

static

Create a new ContactMessenger object.

Parameters

account	The account this messenger is communicating with.
contactIdentifier	The 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.

account()

AccountPtr Tp::ContactMessenger::account

(

)

const

Return the account this messenger is communicating with.

Returns

A pointer to the Account object.

contactIdentifier()

QString Tp::ContactMessenger::contactIdentifier

(

)

const

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

Returns

The identifier of the contact.

textChats()

QList< TextChannelPtr > Tp::ContactMessenger::textChats

(

)

const

Return the list of text chats currently being observed.

Returns

A list of pointers to TextChannel objects.

sendMessage() [1/2]

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

text	The message text.
type	The message type.
flags	The 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.

sendMessage() [2/2]

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

parts	The message parts.
flags	The 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.

messageSent

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

message	The message sent.
flags	The flags of the message that was sent.
sentMessageToken	The token of the message that was sent.
channel	The channel from which the message was sent.

messageReceived

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

message	The message received.
channel	The channel from which the message was received.