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

#include <TelepathyQt4/Client/Connection>

Inheritance diagram for Telepathy::Client::PendingHandles:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ~PendingHandles ()
Connectionconnection () const
uint handleType () const
bool isRequest () const
bool isReference () const
const QStringList & namesRequested () const
const UIntListhandlesToReference () const
ReferencedHandles handles () const

Friends

class Connection
struct Private


Detailed Description

Class containing the parameters of and the reply to an asynchronous handle request/hold. Instances of this class cannot be constructed directly; the only ways to get one are to use Connection::requestHandles() or Connection::referenceHandles().

Constructor & Destructor Documentation

Telepathy::Client::PendingHandles::~PendingHandles (  ) 

Class destructor.


Member Function Documentation

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

Returns the Connection object through which the operation was made.

Returns:
Pointer to the Connection.

ReferencedHandles Telepathy::Client::PendingHandles::handles (  )  const

Returns the now-referenced handles resulting from the operation. If the operation has not (yet) finished successfully (isFinished() returns false), the return value is undefined.

For requests of new handles, handles()[i] will be the handle corresponding to the entity name namesToRequest()[i]. For references of existing handles, handles()[i] == handlesToReference()[i] will be true for any i.

Returns:
ReferencedHandles instance containing the handles.

const UIntList & Telepathy::Client::PendingHandles::handlesToReference (  )  const

If the operation was a reference (as returned by isReference()), returns the handles which were to be referenced. Otherwise, returns an empty list.

Returns:
Reference to a list of the handles specified to be referenced.

uint Telepathy::Client::PendingHandles::handleType (  )  const

Returns the handle type specified in the operation.

Returns:
The handle type, as specified in HandleType.

bool Telepathy::Client::PendingHandles::isReference (  )  const

Returns whether the operation was a handle reference (as opposed to a request for new handles).

See also:
isRequest()
Returns:
Whether the operation was a reference (== !isRequest()).

References isRequest().

bool Telepathy::Client::PendingHandles::isRequest (  )  const

Returns whether the operation was a handle request (as opposed to a reference of existing handles).

See also:
isReference()
Returns:
Whether the operation was a request (== !isReference()).

Referenced by isReference().

const QStringList & Telepathy::Client::PendingHandles::namesRequested (  )  const

If the operation was a request (as returned by isRequest()), returns the names of the entities for which handles were requested for. Otherwise, returns an empty list.

Returns:
Reference to a list of the names of the entities.


Friends And Related Function Documentation

friend class Connection [friend]

friend struct Private [friend]


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