Telepathy::Client::AccountManagerInterface Class Reference

#include <TelepathyQt4/Client/AccountManager>

Inheritance diagram for Telepathy::Client::AccountManagerInterface:

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

Collaboration graph
[legend]

List of all members.

Public Slots

QDBusPendingReply
< QDBusObjectPath > 
CreateAccount (const QString &connectionManager, const QString &protocol, const QString &displayName, const QVariantMap &parameters)

Signals

void AccountRemoved (const QDBusObjectPath &account)
void AccountValidityChanged (const QDBusObjectPath &account, bool valid)

Public Member Functions

 AccountManagerInterface (const QString &serviceName, const QString &objectPath, QObject *parent=0)
 AccountManagerInterface (const QDBusConnection &connection, const QString &serviceName, const QString &objectPath, QObject *parent=0)
 AccountManagerInterface (Telepathy::Client::DBusProxy *proxy)
QStringList Interfaces () const TELEPATHY_GNUC_DEPRECATED
Telepathy::ObjectPathList ValidAccounts () const TELEPATHY_GNUC_DEPRECATED
Telepathy::ObjectPathList InvalidAccounts () const TELEPATHY_GNUC_DEPRECATED

Static Public Member Functions

static const char * staticInterfaceName ()

Protected Member Functions

virtual void invalidate (Telepathy::Client::DBusProxy *, const QString &, const QString &)

Properties

QStringList Interfaces
Telepathy::ObjectPathList ValidAccounts
Telepathy::ObjectPathList InvalidAccounts


Detailed Description

Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.AccountManager."

Constructor & Destructor Documentation

Telepathy::Client::AccountManagerInterface::AccountManagerInterface ( const QString &  serviceName,
const QString &  objectPath,
QObject *  parent = 0 
)

Creates a AccountManagerInterface associated with the given object on the session bus.

Parameters:
serviceName Name of the service the object is on.
objectPath Path to the object on the service.
parent Passed to the parent class constructor.

Telepathy::Client::AccountManagerInterface::AccountManagerInterface ( const QDBusConnection &  connection,
const QString &  serviceName,
const QString &  objectPath,
QObject *  parent = 0 
)

Creates a AccountManagerInterface associated with the given object on the given bus.

Parameters:
connection The bus via which the object can be reached.
serviceName Name of the service the object is on.
objectPath Path to the object on the service.
parent Passed to the parent class constructor.

Telepathy::Client::AccountManagerInterface::AccountManagerInterface ( Telepathy::Client::DBusProxy proxy  ) 

Creates a AccountManagerInterface associated with the same object as the given proxy.

Parameters:
proxy The proxy to use. It will also be the QObject::parent() for this object.


Member Function Documentation

void Telepathy::Client::AccountManagerInterface::AccountRemoved ( const QDBusObjectPath &  account  )  [signal]

Represents the signal "AccountRemoved" on the remote object.

The given account has been removed. This is effectively change notification for the valid and invalid accounts lists. On emission of this signal, the Account indicated will no longer be present in either of the lists.

Parameters:
account An Account, which must not be used any more.

void Telepathy::Client::AccountManagerInterface::AccountValidityChanged ( const QDBusObjectPath &  account,
bool  valid 
) [signal]

Represents the signal "AccountValidityChanged" on the remote object.

The validity of the given account has changed. New accounts are also indicated by this signal, as an account validity change (usually to True) on an account that did not previously exist. This is effectively change notification for the valid and invalid accounts lists.

Parameters:
account An Account.
valid True if the account is now valid.

QDBusPendingReply<QDBusObjectPath> Telepathy::Client::AccountManagerInterface::CreateAccount ( const QString &  connectionManager,
const QString &  protocol,
const QString &  displayName,
const QVariantMap &  parameters 
) [inline, slot]

Begins a call to the D-Bus method "CreateAccount" on the remote object.

Request the creation of a new Account. The account manager SHOULD NOT allow invalid accounts to be created.

Parameters:
connectionManager The name of the connection manager, e.g. "salut".
protocol The protocol, e.g. "local-xmpp".
displayName The initial value of the new account's DisplayName property. The account manager SHOULD modify this to make it unique if an Account already exists with the same display name, for instance by appending a number or the 'account' parameter. Account manager implementations SHOULD accept an empty string but account editing user interfaces should avoid passing an empty string for this parameter. The account creation UI may ask the user for a name for the new account. If the author of the UI chooses not to do this, the account creation UI is better able to suggest a default display name because it has protocol-specific knowledge which the account manager does not. The account manager always knows the complete list of accounts so it can easily tell whether it should append something to the display name to avoid presenting two identically-named accounts to the user.
parameters Initial parameter values, as would be passed to RequestConnection.
Returns:
The new Account.

References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().

QStringList Telepathy::Client::AccountManagerInterface::Interfaces (  )  const [inline]

Getter for the remote object property "Interfaces".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.

Telepathy::ObjectPathList Telepathy::Client::AccountManagerInterface::InvalidAccounts (  )  const [inline]

Getter for the remote object property "InvalidAccounts".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.

virtual void Telepathy::Client::AccountManagerInterface::invalidate ( Telepathy::Client::DBusProxy ,
const QString &  ,
const QString &   
) [protected, virtual]

static const char* Telepathy::Client::AccountManagerInterface::staticInterfaceName (  )  [inline, static]

Returns the name of the interface "org.freedesktop.Telepathy.AccountManager", which this class represents.

Returns:
The D-Bus interface name.

Telepathy::ObjectPathList Telepathy::Client::AccountManagerInterface::ValidAccounts (  )  const [inline]

Getter for the remote object property "ValidAccounts".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.


Property Documentation

QStringList Telepathy::Client::AccountManagerInterface::Interfaces [read]

Represents property "Interfaces" on the remote object.

A list of the interfaces provided by the account manager object.

Telepathy::ObjectPathList Telepathy::Client::AccountManagerInterface::InvalidAccounts [read]

Represents property "InvalidAccounts" on the remote object.

A list of incomplete or otherwise unusable accounts. Change notification is via AccountValidityChanged.

Telepathy::ObjectPathList Telepathy::Client::AccountManagerInterface::ValidAccounts [read]

Represents property "ValidAccounts" on the remote object.

A list of the valid (complete, usable) accounts. Change notification is via AccountValidityChanged. This split between valid and invalid accounts makes it easy to ignore the invalid ones. The only things that should be manipulating invalid accounts are account-editing UIs, which might be able to rescue them.


Generated on Thu Mar 5 18:51:58 2009 for TelepathyQt4-0.1.1 by  doxygen 1.5.8