• Skip to content
  • Skip to link menu
KDE 4.4 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

Akonadi::ResourceSynchronizationJob

Akonadi::ResourceSynchronizationJob Class Reference

Job that synchronizes a resource. More...

#include <resourcesynchronizationjob.h>

Inherits KJob.

List of all members.

Public Member Functions

 ResourceSynchronizationJob (const AgentInstance &instance, QObject *parent=0)
 ~ResourceSynchronizationJob ()
AgentInstance resource () const
void start ()

Detailed Description

Job that synchronizes a resource.

This job will trigger a resource to synchronize the backend it is responsible for (e.g. a local file or a groupware server) with the Akonadi storage.

If you only want to trigger the synchronization without being interested in the result, using Akonadi::AgentInstance::synchronize() is enough. If you want to wait until it's finished, use this class.

Example:

 using namespace Akonadi;

 const AgentInstance resource = AgentManager::self()->instance( "myresourceidentifier" );

 ResourceSynchronizationJob *job = new ResourceSynchronizationJob( resource );
 connect( job, SIGNAL( result( KJob* ) ), SLOT( synchronizationFinished( KJob* ) ) );
Note:
This is a KJob not an Akonadi::Job, so it wont auto-start!
Author:
Volker Krause <vkrause@kde.org>
Since:
4.4

Definition at line 58 of file resourcesynchronizationjob.h.


Constructor & Destructor Documentation

Akonadi::ResourceSynchronizationJob::ResourceSynchronizationJob ( const AgentInstance &  instance,
QObject *  parent = 0 
) [explicit]

Creates a new synchronization job for the given resource.

Parameters:
instance The resource instance to synchronize.

Definition at line 56 of file resourcesynchronizationjob.cpp.

Akonadi::ResourceSynchronizationJob::~ResourceSynchronizationJob (  ) 

Destroys the synchronization job.

Definition at line 67 of file resourcesynchronizationjob.cpp.


Member Function Documentation

AgentInstance Akonadi::ResourceSynchronizationJob::resource (  )  const

Returns the resource that has been synchronized.

Definition at line 124 of file resourcesynchronizationjob.cpp.


The documentation for this class was generated from the following files:
  • resourcesynchronizationjob.h
  • resourcesynchronizationjob.cpp

akonadi

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal