Telepathy::Client::PendingContactAttributes Class Reference
[Connection proxies]

#include <TelepathyQt4/Client/PendingContactAttributes>

Inheritance diagram for Telepathy::Client::PendingContactAttributes:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ~PendingContactAttributes ()
Connectionconnection () const
const UIntListcontactsRequested () const
const QStringList & interfacesRequested () const
bool shouldReference () const
ReferencedHandles validHandles () const
UIntList invalidHandles () const
ContactAttributesMap attributes () const

Friends

class Connection
struct Private


Detailed Description

Class containing the parameters of and the reply to an asynchronous request for raw contact attributes, as used in the Connection::getContactAttributes() low-level convenience method wrapping the ConnectionInterfaceContactsInterface::GetContactAttributes() D-Bus method.

Constructor & Destructor Documentation

Telepathy::Client::PendingContactAttributes::~PendingContactAttributes (  ) 

Class destructor.


Member Function Documentation

ContactAttributesMap Telepathy::Client::PendingContactAttributes::attributes (  )  const

Returns a dictionary mapping the valid contact handles in contactsRequested() (when also referencing, this means the contents of validHandles()) to contact attributes. If the operation has not (yet) finished successfully (isFinished() returns false), the return value is undefined.

Returns:
Mapping from handles to variant maps containing the attributes.

References Telepathy::Client::PendingOperation::isError(), Telepathy::Client::PendingOperation::isFinished(), and Telepathy::warning().

Connection * Telepathy::Client::PendingContactAttributes::connection (  )  const

Returns the Connection object through which the request was made.

Returns:
Pointer to the Connection.

const UIntList & Telepathy::Client::PendingContactAttributes::contactsRequested (  )  const

Returns the contacts for which attributes were requested.

Returns:
Reference to a list with the handles of the contacts.

const QStringList & Telepathy::Client::PendingContactAttributes::interfacesRequested (  )  const

Returns the interfaces the corresponding attributes of which were requested.

Returns:
Reference to a list of D-Bus interface names.

UIntList Telepathy::Client::PendingContactAttributes::invalidHandles (  )  const

Returns the handles which were found to be invalid while processing the operation. If the operation has not (yet) finished successfully (isFinished() returns false), the return value is undefined.

Returns:
A list with the invalid handles.

References Telepathy::Client::PendingOperation::isError(), Telepathy::Client::PendingOperation::isFinished(), and Telepathy::warning().

bool Telepathy::Client::PendingContactAttributes::shouldReference (  )  const

Returns whether it was requested that the contact handles should be referenced in addition to fetching their attributes. This corresponds to the reference argument to Connection::getContactAttributes().

Returns:
Whether the handles should be referenced or not.

Referenced by validHandles().

ReferencedHandles Telepathy::Client::PendingContactAttributes::validHandles (  )  const

If referencing the handles was requested (as indicated by shouldReference()), returns the now-referenced handles resulting from the operation. If the operation has not (yet) finished successfully (isFinished() returns false), or referencing was not requested, the return value is undefined.

Even if referencing was requested, the list will not always contain all of the handles in contactsRequested(), only the ones which were valid. The valid handles will be in the same order as in contactsRequested(), though.

Returns:
ReferencedHandles instance containing the handles.

References Telepathy::Client::PendingOperation::isError(), Telepathy::Client::PendingOperation::isFinished(), shouldReference(), and Telepathy::warning().


Friends And Related Function Documentation

friend class Connection [friend]

friend struct Private [friend]


Generated on Thu Mar 5 18:52:09 2009 for TelepathyQt4-0.1.1 by  doxygen 1.5.8