KDE 4.5 PyKDE API Reference
  • KDE's Python API
  • Overview
  • PyKDE Home
  • Sitemap
  • Contact Us
 

ResourceSynchronizationJob Class Reference

from PyKDE4.akonadi import *

Inherits: KJob → QObject
Namespace: Akonadi

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


Methods

 __init__ (self, Akonadi.AgentInstance instance, QObject parent=0)
Akonadi.AgentInstance resource (self)
 start (self)

Method Documentation

__init__ (  self,
Akonadi.AgentInstance  instance,
QObject  parent=0
)

Creates a new synchronization job for the given resource.

Parameters:
instance  The resource instance to synchronize.

Akonadi.AgentInstance resource (   self )

Returns the resource that has been synchronized.

start (   self )
  • Full Index

Modules

  • akonadi
  • dnssd
  • kdecore
  • kdeui
  • khtml
  • kio
  • knewstuff
  • kparts
  • kutils
  • nepomuk
  • phonon
  • plasma
  • polkitqt
  • solid
  • soprano
This documentation is maintained by Simon Edwards.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal