#include <agentmanager.h>

Inheritance diagram for Akonadi::AgentManager:

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

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Static Public Member Functions
static AgentManager *	self ()

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Additional Inherited Members
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

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 372 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 401 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 396 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 406 of file agentmanager.cpp.

AgentManager * AgentManager::self ( )

static

Returns the global instance of the agent manager.

Definition at line 377 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 411 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 416 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 391 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 386 of file agentmanager.cpp.

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

akonadi

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

akonadi

kdepimlibs API Reference

Search