#include <agentmanager.h>

Inherits QObject.

Signals
void	instanceAdded (const Akonadi::AgentInstance &instance)

void	instanceError (const Akonadi::AgentInstance &instance, const QString &message)

void	instanceNameChanged (const Akonadi::AgentInstance &instance)

void	instanceOnline (const Akonadi::AgentInstance &instance, bool online)

void	instanceProgressChanged (const Akonadi::AgentInstance &instance)

void	instanceRemoved (const Akonadi::AgentInstance &instance)

void	instanceStatusChanged (const Akonadi::AgentInstance &instance)

void	instanceWarning (const Akonadi::AgentInstance &instance, const QString &message)

void	typeAdded (const Akonadi::AgentType &type)

void	typeRemoved (const Akonadi::AgentType &type)

Public Member Functions
	~AgentManager ()

AgentInstance	instance (const QString &identifier) const

AgentInstance::List	instances () const

void	removeInstance (const AgentInstance &instance)

void	synchronizeCollection (const Collection &collection)

void	synchronizeCollection (const Collection &collection, bool recursive)

AgentType	type (const QString &identifier) const

AgentType::List	types () const

Static Public Member Functions
static AgentManager *	self ()

Detailed Description

Provides an interface to retrieve agent types and manage agent instances.

This singleton class can be used to create or remove agent instances or trigger synchronization of collections. Furthermore it provides information about status changes of the agents.

Akonadi::AgentManager *manager = Akonadi::AgentManager::self();
Akonadi::AgentType::List types = manager->types();
foreach ( const Akonadi::AgentType& type, types ) {
  qDebug() << "Type:" << type.name() << type.description();
}

Author: Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org

Definition at line 55 of file agentmanager.h.

Constructor & Destructor Documentation

AgentManager::~AgentManager ( )

Destroys the agent manager.

Definition at line 375 of file agentmanager.cpp.

Member Function Documentation

AgentInstance AgentManager::instance ( const QString & identifier ) const

Returns the agent instance with the given identifier or an invalid agent instance if the identifier does not exist.

Note that because a resource is a special case of an agent, the identifier of a resource is the same as that of its agent instance.

Parameters

identifier identifier to choose the agent instance

Definition at line 404 of file agentmanager.cpp.

void Akonadi::AgentManager::instanceAdded ( const Akonadi::AgentInstance & instance )

signal

This signal is emitted whenever a new agent instance was created.

Parameters

instance The new agent instance.

void Akonadi::AgentManager::instanceError	(	const Akonadi::AgentInstance &	instance,
		const QString &	message
	)

signal

This signal is emitted whenever the agent instance raised an error.

Parameters

instance	The agent instance that raised the error.
message	The i18n'ed error message.

void Akonadi::AgentManager::instanceNameChanged ( const Akonadi::AgentInstance & instance )

signal

This signal is emitted whenever the name of the agent instance has changed.

Parameters

instance The agent instance that name has changed.

void Akonadi::AgentManager::instanceOnline	(	const Akonadi::AgentInstance &	instance,
		bool	online
	)

signal

This signal is emitted whenever the online state of an agent changed.

Parameters

instance	The agent instance that changed its online state.
online	The new online state.

Since: 4.2

void Akonadi::AgentManager::instanceProgressChanged ( const Akonadi::AgentInstance & instance )

signal

This signal is emitted whenever the progress of an agent instance has changed.

Parameters

instance The agent instance that progress has changed.

void Akonadi::AgentManager::instanceRemoved ( const Akonadi::AgentInstance & instance )

signal

This signal is emitted whenever an agent instance was removed.

Parameters

instance The removed agent instance.

AgentInstance::List AgentManager::instances ( ) const

Returns the list of all available agent instances.

Definition at line 399 of file agentmanager.cpp.

void Akonadi::AgentManager::instanceStatusChanged ( const Akonadi::AgentInstance & instance )

signal

This signal is emitted whenever the status of an agent instance has changed.

Parameters

instance The agent instance that status has changed.

void Akonadi::AgentManager::instanceWarning	(	const Akonadi::AgentInstance &	instance,
		const QString &	message
	)

signal

This signal is emitted whenever the agent instance raised a warning.

Parameters

instance	The agent instance that raised the warning.
message	The i18n'ed warning message.

void AgentManager::removeInstance ( const AgentInstance & instance )

Removes the given agent instance.

Definition at line 409 of file agentmanager.cpp.

AgentManager * AgentManager::self ( )

static

Returns the global instance of the agent manager.

Definition at line 380 of file agentmanager.cpp.

void AgentManager::synchronizeCollection ( const Collection & collection )

Trigger a synchronization of the given collection by its owning resource agent.

Parameters

collection The collection to synchronize.

Definition at line 414 of file agentmanager.cpp.

void AgentManager::synchronizeCollection	(	const Collection &	collection,
		bool	recursive
	)

Trigger a synchronization of the given collection by its owning resource agent.

Parameters

collection	The collection to synchronize.
recursive	If true, the sub-collections are also synchronized

Since: 4.6

Definition at line 419 of file agentmanager.cpp.

AgentType AgentManager::type ( const QString & identifier ) const

Returns the agent type with the given identifier or an invalid agent type if the identifier does not exist.

Definition at line 394 of file agentmanager.cpp.

void Akonadi::AgentManager::typeAdded ( const Akonadi::AgentType & type )

signal

This signal is emitted whenever a new agent type was installed on the system.

Parameters

type	The new agent type.

void Akonadi::AgentManager::typeRemoved ( const Akonadi::AgentType & type )

signal

This signal is emitted whenever an agent type was removed from the system.

Parameters

type	The removed agent type.

AgentType::List AgentManager::types ( ) const

Returns the list of all available agent types.

Definition at line 389 of file agentmanager.cpp.

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

akonadi

Signals

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

akonadi

kdepimlibs API Reference

Search