Akonadi::AgentManager

#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)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (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
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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
 
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)
 
qobject_cast (QObject *object)
 
qobject_cast (const 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)
 
QThreadthread () const const
 

Static Public Member Functions

static AgentManagerself ()
 
- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction 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

- 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
 
QObjectsender () 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.

for ( const Akonadi::AgentType& type : types ) {
qDebug() << "Type:" << type.name() << type.description();
}
Author
Tobias Koenig tokoe[email protected]@kde[email protected].org

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

Constructor & Destructor Documentation

AgentManager::~AgentManager ( )
default

Destroys the agent manager.

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
identifieridentifier to choose the agent instance

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

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

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

Parameters
instanceThe 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
instanceThe agent instance that raised the error.
messageThe 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
instanceThe 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
instanceThe agent instance that changed its online state.
onlineThe 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
instanceThe 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
instanceThe removed agent instance.
AgentInstance::List AgentManager::instances ( ) const

Returns the list of all available agent instances.

Definition at line 381 of file core/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
instanceThe 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
instanceThe agent instance that raised the warning.
messageThe i18n'ed warning message.
void AgentManager::removeInstance ( const AgentInstance instance)

Removes the given agent instance.

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

AgentManager * AgentManager::self ( )
static

Returns the global instance of the agent manager.

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

void AgentManager::synchronizeCollection ( const Collection collection)

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

Parameters
collectionThe collection to synchronize.

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

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

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

Parameters
collectionThe collection to synchronize.
recursiveIf true, the sub-collections are also synchronized
Since
4.6

Definition at line 401 of file core/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 376 of file core/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
typeThe 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
typeThe removed agent type.
AgentType::List AgentManager::types ( ) const

Returns the list of all available agent types.

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


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Nov 21 2020 23:17:07 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.