Akonadi::AgentInstance Class Reference

#include <agentinstance.h>

Inherited by Akonadi::AgentBrokenInstance, Akonadi::AgentProcessInstance, and Akonadi::AgentThreadInstance.

Public Types

typedef QVector< AgentInstanceList
enum  Status { Idle = 0, Running, Broken, NotConfigured }

Public Member Functions

 AgentInstance ()
 AgentInstance (const AgentInstance &other)
 ~AgentInstance ()
void abortCurrentTask () const
AKONADICORE_DEPRECATED void configure (QWidget *parent=nullptr)
QString identifier () const
bool isOnline () const
bool isValid () const
QString name () const
AgentInstanceoperator= (const AgentInstance &other)
bool operator== (const AgentInstance &other) const
int progress () const
void reconfigure () const
void restart () const
void setIsOnline (bool online)
void setName (const QString &name)
Status status () const
QString statusMessage () const
void synchronize ()
void synchronizeCollectionTree ()
void synchronizeRelations ()
void synchronizeTags ()
AgentType type () const

Detailed Description

A representation of an agent instance.

The agent instance is a representation of a running agent process. It provides information about the instance and a reference to the AgentType of that instance.

All available agent instances can be retrieved from the AgentManager.

for( const Akonadi::AgentInstance &instance : instances ) {
qDebug() << "Name:" << instance.name() << "(" << instance.identifier() << ")";
To find the collections belonging to an AgentInstance, use CollectionFetchJob and supply AgentInstance::identifier() as the parameter to CollectionFetchScope::setResource().
Tobias Koenig tokoe[email protected]@kde[email protected].org

Definition at line 60 of file core/agentinstance.h.

Member Typedef Documentation

Describes a list of agent instances.

Definition at line 69 of file core/agentinstance.h.

Member Enumeration Documentation

Describes the status of the agent instance.


The agent instance does currently nothing.


The agent instance is working on something.


The agent instance encountered an error state.


The agent is lacking required configuration.

Definition at line 74 of file core/agentinstance.h.

Constructor & Destructor Documentation

AgentInstance::AgentInstance ( )

Creates a new agent instance object.

Definition at line 31 of file core/agentinstance.cpp.

AgentInstance::AgentInstance ( const AgentInstance other)

Creates an agent instance from an other agent instance.

Definition at line 36 of file core/agentinstance.cpp.

AgentInstance::~AgentInstance ( )

Destroys the agent instance object.

Definition at line 41 of file core/agentinstance.cpp.

Member Function Documentation

void AgentInstance::abortCurrentTask ( ) const

Tell the agent to abort its current operation.


Definition at line 144 of file core/agentinstance.cpp.

void AgentInstance::configure ( QWidget parent = nullptr)

Triggers the agent instance to show its configuration dialog.

Use the new Akonadi::AgentConfigurationWidget and Akonadi::AgentConfigurationDialog to display configuration dialogs in-process
parentParent window for the configuration dialog.

Definition at line 105 of file core/agentinstance.cpp.

QString AgentInstance::identifier ( ) const

Returns the unique identifier of the agent instance.

Definition at line 55 of file core/agentinstance.cpp.

bool AgentInstance::isOnline ( ) const

Returns whether the agent instance is online currently.

Definition at line 95 of file core/agentinstance.cpp.

bool AgentInstance::isValid ( ) const

Returns whether the agent instance object is valid.

Definition at line 45 of file core/agentinstance.cpp.

QString AgentInstance::name ( ) const

Returns the user visible name of the agent instance.

Definition at line 65 of file core/agentinstance.cpp.

AgentInstance & AgentInstance::operator= ( const AgentInstance other)
otherother agent instance

Definition at line 130 of file core/agentinstance.cpp.

bool AgentInstance::operator== ( const AgentInstance other) const
otherother agent instance

Definition at line 139 of file core/agentinstance.cpp.

int AgentInstance::progress ( ) const

Returns the progress of the agent instance in percent, or -1 if no progress information are available.

Definition at line 90 of file core/agentinstance.cpp.

void AgentInstance::reconfigure ( ) const

Tell the agent that its configuration has been changed remotely via D-Bus.

Definition at line 159 of file core/agentinstance.cpp.

void AgentInstance::restart ( ) const

Restart the agent process.

Definition at line 174 of file core/agentinstance.cpp.

void AgentInstance::setIsOnline ( bool  online)

Sets online status of the agent instance.

Definition at line 100 of file core/agentinstance.cpp.

void AgentInstance::setName ( const QString name)

Sets the user visible name of the agent instance.

Definition at line 60 of file core/agentinstance.cpp.

AgentInstance::Status AgentInstance::status ( ) const

Returns the status of the agent instance.

Definition at line 70 of file core/agentinstance.cpp.

QString AgentInstance::statusMessage ( ) const

Returns a textual presentation of the status of the agent instance.

Definition at line 85 of file core/agentinstance.cpp.

void AgentInstance::synchronize ( )

Triggers the agent instance to start synchronization.

Definition at line 110 of file core/agentinstance.cpp.

void AgentInstance::synchronizeCollectionTree ( )

Triggers a synchronization of the collection tree by the given agent instance.

Definition at line 115 of file core/agentinstance.cpp.

void AgentInstance::synchronizeRelations ( )

Triggers a synchronization of relations by the given agent instance.

Definition at line 125 of file core/agentinstance.cpp.

void AgentInstance::synchronizeTags ( )

Triggers a synchronization of tags by the given agent instance.

Definition at line 120 of file core/agentinstance.cpp.

AgentType AgentInstance::type ( ) const

Returns the agent type of this instance.

Definition at line 50 of file core/agentinstance.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 Wed Jul 1 2020 23:14:23 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.