Akonadi::AgentInstance Class Reference

#include <agentinstance.h>

Classes
class	Private

Public Types
typedef QList< AgentInstance >	List
enum	Status { Idle = 0, Running, Broken, NotConfigured }

Public Member Functions
	AgentInstance ()
	AgentInstance (const AgentInstance &other)
	~AgentInstance ()
void	abortCurrentTask () const
void	configure (QWidget *parent=0)
QString	identifier () const
bool	isOnline () const
bool	isValid () const
QString	name () const
AgentInstance &	operator= (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 ()
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.

Akonadi::AgentInstance::List instances = Akonadi::AgentManager::self()->instances();
foreach ( const Akonadi::AgentInstance &instance, instances ) {
  qDebug() << "Name:" << instance.name() << "(" << instance.identifier() << ")";
}

Note

To find the collections belonging to an AgentInstance, use CollectionFetchJob and supply AgentInstance::identifier() as the parameter to CollectionFetchScope::setResource().

Author

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

Definition at line 62 of file agentinstance.h.

Member Typedef Documentation

typedef QList<AgentInstance> Akonadi::AgentInstance::List

Describes a list of agent instances.

Definition at line 71 of file agentinstance.h.

Member Enumeration Documentation

enum Akonadi::AgentInstance::Status

Describes the status of the agent instance.

Enumerator
Idle	The agent instance does currently nothing.
Running	The agent instance is working on something.
Broken	The agent instance encountered an error state.
NotConfigured	The agent is lacking required configuration.

Definition at line 76 of file agentinstance.h.

Constructor & Destructor Documentation

AgentInstance::AgentInstance

(

)

Creates a new agent instance object.

Definition at line 31 of file agentinstance.cpp.

AgentInstance::AgentInstance

(

const AgentInstance &

other

)

Creates an agent instance from an other agent instance.

Definition at line 36 of file agentinstance.cpp.

AgentInstance::~AgentInstance

(

)

Destroys the agent instance object.

Definition at line 41 of file agentinstance.cpp.

Member Function Documentation

void AgentInstance::abortCurrentTask

(

)

const

Tell the agent to abort its current operation.

Since

4.4

Definition at line 134 of file agentinstance.cpp.

void AgentInstance::configure

(

QWidget *

parent = 0

)

Triggers the agent instance to show its configuration dialog.

Parameters

parent

Parent window for the configuration dialog.

Definition at line 105 of file agentinstance.cpp.

QString AgentInstance::identifier

(

)

const

Returns the unique identifier of the agent instance.

Definition at line 55 of file agentinstance.cpp.

bool AgentInstance::isOnline

(

)

const

Returns whether the agent instance is online currently.

Definition at line 95 of file agentinstance.cpp.

bool AgentInstance::isValid

(

)

const

Returns whether the agent instance object is valid.

Definition at line 45 of file agentinstance.cpp.

QString AgentInstance::name

(

)

const

Returns the user visible name of the agent instance.

Definition at line 65 of file agentinstance.cpp.

AgentInstance & AgentInstance::operator=

(

const AgentInstance &

other

)

Parameters

other

other agent instance

Definition at line 120 of file agentinstance.cpp.

bool AgentInstance::operator==

(

const AgentInstance &

other

)

const

Parameters

other

other agent instance

Definition at line 129 of file 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 agentinstance.cpp.

void AgentInstance::reconfigure

(

)

const

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

Definition at line 149 of file agentinstance.cpp.

void Akonadi::AgentInstance::restart

(

)

const

Restart the agent process.

Definition at line 164 of file agentinstance.cpp.

void AgentInstance::setIsOnline

(

bool

online

)

Sets online status of the agent instance.

Definition at line 100 of file agentinstance.cpp.

void AgentInstance::setName

(

const QString &

name

)

Sets the user visible name of the agent instance.

Definition at line 60 of file agentinstance.cpp.

AgentInstance::Status AgentInstance::status

(

)

const

Returns the status of the agent instance.

Definition at line 70 of file agentinstance.cpp.

QString AgentInstance::statusMessage

(

)

const

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

Definition at line 85 of file agentinstance.cpp.

void AgentInstance::synchronize

(

)

Triggers the agent instance to start synchronization.

Definition at line 110 of file agentinstance.cpp.

void AgentInstance::synchronizeCollectionTree

(

)

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

Definition at line 115 of file agentinstance.cpp.

AgentType AgentInstance::type

(

)

const

Returns the agent type of this instance.

Definition at line 50 of file agentinstance.cpp.

---

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

• agentinstance.h
• agentinstance.cpp