Manager of accounts, services and providers. More...

#include <Accounts/Manager>

Signals
void	accountCreated (Accounts::AccountId id)
	The signal is emitted when new account is created.
void	accountRemoved (Accounts::AccountId id)
	The signal is emitted when existing account is removed.
void	accountUpdated (Accounts::AccountId id)
	The signal is emitted when any account property for a particular service is updated.
void	enabledEvent (Accounts::AccountId id)
	If the manager has been created with serviceType, this signal will be emitted when an account (identified by AccountId) has been modified in such a way that the application might be interested to start/stop using it: the "enabled" flag on the account or in some service supported by the account and matching the AgManager::serviceType have changed.
Public Member Functions
	Manager (QObject *parent=0)
	Constructor.
	Manager (const QString &serviceType, QObject *parent=0)
	Constructs a manager initialized with service type.
	~Manager ()
	Destructor.
Account *	account (const AccountId &id) const
	Loads an account from the database.
AccountIdList	accountList (const QString &serviceType=QString::null) const
	Lists the accounts which support the requested service.
AccountIdList	accountListEnabled (const QString &serviceType=QString::null) const
	Lists the enabled accounts which support the requested service that also must be enabled.
Account *	createAccount (const QString &providerName)
	Creates a new account.
Service *	service (const QString &serviceName) const
	Gets an object representing a service.
ServiceList	serviceList (const QString &serviceType=QString::null) const
	Gets the service list.
Provider *	provider (const QString &providerName) const
	Gets an object representing a provider.
ProviderList	providerList () const
	Gets a provider list.
ServiceType *	serviceType (const QString &name) const
	Gets an object representing a service type.
QString	serviceType () const
	Gets the service type if given in manager constructor.
void	setTimeout (quint32 timeout)
	Sets the timeout for database operations.
quint32	timeout ()
	Gets the database timeout.
void	setAbortOnTimeout (bool abort)
	Sets whether to abort the application when a database timeout occurs.
bool	abortOnTimeout () const
Error	lastError () const
	Gets the last error.

Detailed Description

Manager of accounts, services and providers.

The Manager offers ways to create accounts, list accounts, services and providers. It also emits signals when accounts are created and removed.

Definition at line 47 of file manager.h.

Constructor & Destructor Documentation

Manager ( QObject * parent = 0 )

Constructor.

Users should check for manager->lastError() to check if manager construction was fully succesful.

Definition at line 206 of file manager.cpp.

References Error::DatabaseLocked.

Manager	(	const QString &	serviceType,
		QObject *	parent = `0`
	)

Constructs a manager initialized with service type.

This constructor should be used when there is an interest for just one service type. Such a manager has influence on some class methods. When listing the accounts and services only the ones supporting the given service type will be returned. Also the creating account with this manager will affect the acccount class method for listing services in same manner. The signal enabledEvent() will be emitted only when manager is created with this constructor. Users should check for manager->lastError() to check if manager construction was fully succesful.

Definition at line 234 of file manager.cpp.

References Error::DatabaseLocked.

Member Function Documentation

bool abortOnTimeout ( ) const

Returns:: Whether the application will be aborted when a database timeout occurs.

Definition at line 591 of file manager.cpp.

Account * account ( const AccountId & id ) const

Loads an account from the database.

Parameters:

id	Id of the account to be retrieved.

Returns:: Requested account or NULL if not found. If NULL is returned, call lastError() to find out why.

Definition at line 279 of file manager.cpp.

Referenced by Manager::createAccount().

accountCreated ( Accounts::AccountId id ) [signal]

The signal is emitted when new account is created.

Parameters:

id	Identifier of the Account

AccountIdList accountList ( const QString & serviceType = QString::null ) const

Lists the accounts which support the requested service.

Parameters:

serviceType Type of service that returned accounts must support. If not given and the manager is not constructed with service type, all accounts are returned.

Returns:: List of account IDs.

Definition at line 308 of file manager.cpp.

AccountIdList accountListEnabled ( const QString & serviceType = QString::null ) const

Lists the enabled accounts which support the requested service that also must be enabled.

Parameters:

serviceType Type of service that returned accounts must support. If not given and the manager is not constructed with service type, all enabled accounts are returned.

Returns:: List of account IDs.

Definition at line 343 of file manager.cpp.

accountRemoved ( Accounts::AccountId id ) [signal]

The signal is emitted when existing account is removed.

Parameters:

id	Identifier of the Account

accountUpdated ( Accounts::AccountId id ) [signal]

The signal is emitted when any account property for a particular service is updated.

To receive this notification user has to create accounts manager using Manager(const QString &serviceType, QObject *parent) constructor. Update notification is only emitted when manager is created for particular type of service.

Parameters:

id	Identifier of the Account

Account * createAccount ( const QString & providerName )

Creates a new account.

Parameters:

providerName Name of account provider.

Returns:: Created account or NULL if some error occurs.

Definition at line 373 of file manager.cpp.

References Manager::account().

enabledEvent ( Accounts::AccountId id ) [signal]

If the manager has been created with serviceType, this signal will be emitted when an account (identified by AccountId) has been modified in such a way that the application might be interested to start/stop using it: the "enabled" flag on the account or in some service supported by the account and matching the AgManager::serviceType have changed.

Note:: In practice, this signal might be emitted more often than when strictly needed; applications must call Account::enabledServices() to get the current state.

Parameters:

id	identifier of the Account

Error lastError ( ) const

Gets the last error.

Not all operations set/reset the error; see the individual methods' documentation to see if they set the last error or not. Call this method right after an account operation has failed; if no error occurred, the result of this method are undefined.

Returns:: The last error.

Definition at line 605 of file manager.cpp.

Provider * provider ( const QString & providerName ) const

Gets an object representing a provider.

Parameters:

providerName Name of provider to get.

Returns:: Requested provider or NULL if not found.

Definition at line 481 of file manager.cpp.

ProviderList providerList ( ) const

Gets a provider list.

Returns:: List of registered providers.

Definition at line 501 of file manager.cpp.

Service * service ( const QString & serviceName ) const

Gets an object representing a service.

Parameters:

serviceName Name of service to get.

Returns:: Requested service or NULL if not found.

Definition at line 410 of file manager.cpp.

ServiceList serviceList ( const QString & serviceType = QString::null ) const

Gets the service list.

If the manager is constructed with given service type only the services which supports the service type will be returned.

Parameters:

serviceType Type of services to be listed. If not given and the manager is not constructed with service type, all services are listed.

Returns:: List of Service objects.

Definition at line 434 of file manager.cpp.

References Manager::serviceType().

ServiceType * serviceType ( const QString & name ) const

Gets an object representing a service type.

Parameters:

name	Name of service type to load.

Returns:: Requested service type or NULL if not found.

Definition at line 528 of file manager.cpp.

References Manager::serviceType().

QString serviceType ( ) const

Gets the service type if given in manager constructor.

Returns:: Service type or NULL if not given.

Definition at line 550 of file manager.cpp.

Referenced by Manager::serviceList(), and Manager::serviceType().

void setAbortOnTimeout ( bool abort )

Sets whether to abort the application when a database timeout occurs.

By default the library does not abort the application.

Definition at line 582 of file manager.cpp.

void setTimeout ( quint32 timeout )

Sets the timeout for database operations.

Parameters:

timeout The new timeout in milliseconds.

This tells the library how long it is allowed to block while waiting for a locked DB to become accessible. Higher values mean a higher chance of successful reads, but also mean that the execution might be blocked for a longer time. The default is 5 seconds.

Definition at line 564 of file manager.cpp.

quint32 timeout ( )

Gets the database timeout.

Returns:: The timeout (in milliseconds) for database operations.

Definition at line 573 of file manager.cpp.

The documentation for this class was generated from the following files:

Accounts/manager.h
Accounts/manager.cpp

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation