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

#include <TelepathyQt4/Client/ConnectionManager>

Collaboration diagram for Telepathy::Client::ProtocolInfo:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ~ProtocolInfo ()
QString cmName () const
QString name () const
const ProtocolParameterListparameters () const
bool hasParameter (const QString &name) const
bool canRegister () const

Friends

class Private
class ConnectionManager


Detailed Description

Object representing a Telepathy protocol info.

Constructor & Destructor Documentation

Telepathy::Client::ProtocolInfo::~ProtocolInfo (  ) 

Class destructor.


Member Function Documentation

bool Telepathy::Client::ProtocolInfo::canRegister (  )  const

Return whether it might be possible to register new accounts on this protocol via Telepathy, by setting the special parameter named register to true.

Returns:
The same thing as hasParameter("register").
See also:
hasParameter()

References hasParameter().

QString Telepathy::Client::ProtocolInfo::cmName (  )  const [inline]

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

Returns:
The name of the connection manager.

Referenced by Telepathy::Client::ConnectionManager::ConnectionManager::Private::parseConfigFile().

bool Telepathy::Client::ProtocolInfo::hasParameter ( const QString &  name  )  const

Return whether a given parameter can be passed to the connection manager when creating a connection to this protocol.

Parameters:
name The name of a parameter.
Returns:
true if the given parameter exists.

References Telepathy::Client::ProtocolParameter::name().

Referenced by canRegister().

QString Telepathy::Client::ProtocolInfo::name (  )  const [inline]

Get the string identifying the protocol as described in the Telepathy D-Bus API Specification (e.g. "jabber").

This identifier is not intended to be displayed to users directly; user interfaces are responsible for mapping them to localized strings.

Returns:
A string identifying the protocol.

Referenced by Telepathy::Client::ConnectionManager::ConnectionManager::Private::parseConfigFile(), Telepathy::Client::ConnectionManager::ConnectionManager::Private::protocol(), and Telepathy::Client::ConnectionManager::supportedProtocols().

const ProtocolParameterList & Telepathy::Client::ProtocolInfo::parameters (  )  const

Return all supported parameters. The parameters' names may either be the well-known strings specified by the Telepathy D-Bus API Specification (e.g. "account" and "password"), or implementation-specific strings.

Returns:
A list of parameters.

Referenced by Telepathy::Client::ConnectionManager::ConnectionManager::Private::parseConfigFile().


Friends And Related Function Documentation

friend class ConnectionManager [friend]

friend class Private [friend]


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