• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.11.3 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • AgentManager
Signals | Public Member Functions | Static Public Member Functions | List of all members
Akonadi::AgentManager Class Reference

#include <agentmanager.h>

Inherits QObject.

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
 

Static Public Member Functions

static AgentManager * self ()
 

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

Definition at line 403 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
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 398 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
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 408 of file agentmanager.cpp.

AgentManager * AgentManager::self ( )
static

Returns the global instance of the agent manager.

Definition at line 379 of file 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 413 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
collectionThe collection to synchronize.
recursiveIf true, the sub-collections are also synchronized
Since
4.6

Definition at line 418 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 393 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
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 388 of file agentmanager.cpp.


The documentation for this class was generated from the following files:
  • agentmanager.h
  • agentmanager.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:03:22 by doxygen 1.8.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.11.3 API Reference

Skip menu "kdepimlibs-4.11.3 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal