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.

Classes

struct  Private

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

Static Public Member Functions

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

Static Public Attributes

static const Feature FeatureCore = Feature(ConnectionManager::staticMetaObject.className(), 0, true)

Protected Member Functions

ConnectionManagerInterfacebaseInterface () const

Friends

struct Private
class PendingConnection


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.


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.

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.

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

Class destructor.


Member Function Documentation

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::ConnectionManager::Private::baseInterface.

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

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.

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::ConnectionManager::Private::name.

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.

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::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.

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::ConnectionManager::Private::protocols, and protocols().


Friends And Related Function Documentation

friend class PendingConnection [friend]

Referenced by requestConnection().

friend struct Private [friend]


Member Data Documentation

const Feature Telepathy::Client::ConnectionManager::FeatureCore = Feature(ConnectionManager::staticMetaObject.className(), 0, true) [static]


Generated on Mon Mar 23 18:02:28 2009 for TelepathyQt4-0.1.2 by  doxygen 1.5.8