Telepathy::Client::ConnectionManager Class Reference
[Connection manager proxies]

#include <TelepathyQt4/Client/ConnectionManager>

Inheritance diagram for Telepathy::Client::ConnectionManager:

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

Collaboration graph
[legend]

List of all members.


Detailed Description

Object representing a Telepathy connection manager. Connection managers allow connections to be made on one or more protocols.

Most client applications should use this functionality via the AccountManager, to allow connections to be shared between client applications.

Public Types

enum  Feature { _Padding = 0xFFFFFFFF }

Public Member Functions

 ConnectionManager (const QString &name, QObject *parent=0)
 ConnectionManager (const QDBusConnection &bus, const QString &name, QObject *parent=0)
virtual ~ConnectionManager ()
QString name () const
QStringList interfaces () const
QStringList supportedProtocols () const
const ProtocolInfoListprotocols () const
PendingConnectionrequestConnection (const QString &protocol, const QVariantMap &parameters)
DBus::PropertiesInterfacepropertiesInterface () const
bool isReady (Features features=0) const
PendingReadyConnectionManagerbecomeReady (Features features=0)

Static Public Member Functions

static PendingStringListlistNames (const QDBusConnection &bus=QDBusConnection::sessionBus())

Protected Member Functions

ConnectionManagerInterfacebaseInterface () const

Friends

struct Private
class PendingConnection

Classes

struct  Private


Member Enumeration Documentation

Enumerator:
_Padding 


Constructor & Destructor Documentation

Telepathy::Client::ConnectionManager::ConnectionManager ( const QString &  name,
QObject *  parent = 0 
)

Construct a new ConnectionManager object.

Parameters:
name Name of the connection manager.
parent Object parent.

References Telepathy::Client::ConnectionManager::Private::introspectQueue, and Telepathy::Client::DBusProxy::isValid().

Telepathy::Client::ConnectionManager::ConnectionManager ( const QDBusConnection &  bus,
const QString &  name,
QObject *  parent = 0 
)

Construct a new ConnectionManager object.

Parameters:
bus QDBusConnection to use.
name Name of the connection manager.
parent Object parent.

References Telepathy::Client::ConnectionManager::Private::introspectQueue, and Telepathy::Client::DBusProxy::isValid().

Telepathy::Client::ConnectionManager::~ConnectionManager (  )  [virtual]

Class destructor.


Member Function Documentation

QString Telepathy::Client::ConnectionManager::name (  )  const

Get the short name of the connection manager (e.g. "gabble").

Returns:
The name of the connection manager.

References Telepathy::Client::ConnectionManager::Private::name.

QStringList Telepathy::Client::ConnectionManager::interfaces (  )  const

QStringList Telepathy::Client::ConnectionManager::supportedProtocols (  )  const

Get a list of strings identifying the protocols supported by this connection manager, as described in the Telepathy D-Bus API Specification (e.g. "jabber").

These identifiers are not intended to be displayed to users directly; user interfaces are responsible for mapping them to localized strings.

Returns:
A list of supported protocols.

References Telepathy::Client::ProtocolInfo::name(), Telepathy::Client::ConnectionManager::Private::protocols, and protocols().

const ProtocolInfoList & Telepathy::Client::ConnectionManager::protocols (  )  const

Get a list of protocols info for this connection manager.

Returns:
A list of á¹”rotocolInfo.

References Telepathy::Client::ConnectionManager::Private::protocols.

Referenced by supportedProtocols().

PendingConnection * Telepathy::Client::ConnectionManager::requestConnection ( const QString &  protocol,
const QVariantMap &  parameters 
)

Request a Connection object representing a given account on a given protocol with the given parameters.

Return a pending operation representing the Connection object which will succeed when the connection has been created or fail if an error occurred.

Parameters:
protocol Name of the protocol to create the account for.
parameters Account parameters.
Returns:
A PendingOperation which will emit PendingConnection::finished when the account has been created of failed its creation process.

References PendingConnection.

DBus::propertiesInterface * Telepathy::Client::ConnectionManager::propertiesInterface (  )  const [inline]

Convenience function for getting a Properties interface proxy. The Properties interface is not necessarily reported by the services, so a check parameter is not provided, and the interface is always assumed to be present.

bool Telepathy::Client::ConnectionManager::isReady ( Features  features = 0  )  const

Return whether this object has finished its initial setup.

This is mostly useful as a sanity check, in code that shouldn't be run until the object is ready. To wait for the object to be ready, call becomeReady() and connect to the finished signal on the result.

Returns:
true if the object has finished initial setup.

References Telepathy::Client::ConnectionManager::Private::features, and Telepathy::Client::ConnectionManager::Private::ready.

Referenced by becomeReady().

PendingReadyConnectionManager * Telepathy::Client::ConnectionManager::becomeReady ( Features  requestedFeatures = 0  ) 

Return a pending operation which will succeed when this object finishes its initial setup, or will fail if a fatal error occurs during this initial setup.

Returns:
A PendingReadyConnectionManager object which will emit finished when this object has finished or failed its initial setup.

References isReady(), Telepathy::Client::DBusProxy::isValid(), Telepathy::Client::ConnectionManager::Private::pendingReady, Telepathy::Client::PendingOperation::setFinished(), Telepathy::Client::PendingOperation::setFinishedWithError(), and TELEPATHY_ERROR_NOT_AVAILABLE.

PendingStringList * Telepathy::Client::ConnectionManager::listNames ( const QDBusConnection &  bus = QDBusConnection::sessionBus()  )  [static]

Return a pending operation from which a list of all installed connection manager short names (such as "gabble" or "haze") can be retrieved if it succeeds.

Returns:
A PendingStringList which will emit PendingStringList::finished when this object has finished or failed getting the connection manager names.

ConnectionManagerInterface * Telepathy::Client::ConnectionManager::baseInterface (  )  const [protected]

Get the ConnectionManagerInterface for this ConnectionManager. This method is protected since the convenience methods provided by this class should generally be used instead of calling D-Bus methods directly.

Returns:
A pointer to the existing ConnectionManagerInterface for this ConnectionManager.

References Telepathy::Client::ConnectionManager::Private::baseInterface.


Friends And Related Function Documentation

friend struct Private [friend]

friend class PendingConnection [friend]

Referenced by requestConnection().


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