Akonadi::AgentManager Class Reference

#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 () override
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)
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread *	thread () const const

Static Public Member Functions
static AgentManager *	self ()
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
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)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Additional Inherited Members
Properties inherited from QObject
	objectName
Public Attributes inherited from QObject
typedef	QObjectList
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

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();
for ( const Akonadi::AgentType& type : types ) {
  qDebug() << "Type:" << type.name() << type.description();
}

Author

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

Definition at line 43 of file core/agentmanager.h.

Constructor & Destructor Documentation

~AgentManager()

AgentManager::~AgentManager ( )

overridedefault

Destroys the agent manager.

Member Function Documentation

instance()

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 385 of file core/agentmanager.cpp.

instanceAdded

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.

instanceError

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.

instanceNameChanged

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.

instanceOnline

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

instanceProgressChanged

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.

instanceRemoved

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.

instances()

AgentInstance::List AgentManager::instances

(

)

const

Returns the list of all available agent instances.

Definition at line 380 of file core/agentmanager.cpp.

instanceStatusChanged

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.

instanceWarning

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.

removeInstance()

void AgentManager::removeInstance

(

const AgentInstance &

instance

)

Removes the given agent instance.

Definition at line 390 of file core/agentmanager.cpp.

self()

AgentManager * AgentManager::self ( )

static

Returns the global instance of the agent manager.

Definition at line 355 of file core/agentmanager.cpp.

synchronizeCollection() [1/2]

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 395 of file core/agentmanager.cpp.

synchronizeCollection() [2/2]

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 400 of file core/agentmanager.cpp.

type()

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 375 of file core/agentmanager.cpp.

typeAdded

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.

typeRemoved

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.

types()

AgentType::List AgentManager::types

(

)

const

Returns the list of all available agent types.

Definition at line 364 of file core/agentmanager.cpp.

---

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

• core/agentmanager.h
• core/agentmanager.cpp