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

akonadi

  • Akonadi
  • UnlinkJob
Public Member Functions | Protected Member Functions | List of all members
Akonadi::UnlinkJob Class Reference

#include <unlinkjob.h>

Inheritance diagram for Akonadi::UnlinkJob:
Inheritance graph
[legend]

Public Member Functions

 UnlinkJob (const Collection &collection, const Item::List &items, QObject *parent=0)
 
 ~UnlinkJob ()
 
- Public Member Functions inherited from Akonadi::Job
 Job (QObject *parent=0)
 
virtual ~Job ()
 
virtual QString errorString () const
 
void start ()
 

Protected Member Functions

void doStart ()
 
- Protected Member Functions inherited from Akonadi::Job
virtual bool addSubjob (KJob *job)
 
virtual void doHandleResponse (const QByteArray &tag, const QByteArray &data)
 
virtual bool doKill ()
 
void emitWriteFinished ()
 
virtual bool removeSubjob (KJob *job)
 

Additional Inherited Members

- Public Types inherited from Akonadi::Job
enum  Error {
  ConnectionFailed = UserDefinedError, ProtocolVersionMismatch, UserCanceled, Unknown,
  UserError = UserDefinedError + 42
}
 
typedef QList< Job * > List
 
- Signals inherited from Akonadi::Job
void aboutToStart (Akonadi::Job *job)
 
void writeFinished (Akonadi::Job *job)
 
- Protected Slots inherited from Akonadi::Job
virtual void slotResult (KJob *job)
 

Detailed Description

Job that unlinks items inside the Akonadi storage.

This job allows you to remove references to a set of items in a virtual collection.

Example:

// Unlink the given items from the given collection
const Akonadi::Collection virtualCollection = ...
const Akonadi::Item::List items = ...
Akonadi::UnlinkJob *job = new Akonadi::UnlinkJob( virtualCollection, items );
connect( job, SIGNAL( result( KJob* ) ), SLOT( jobFinished( KJob* ) ) );
...
MyClass::jobFinished( KJob *job )
{
if ( job->error() )
qDebug() << "Error occurred";
else
qDebug() << "Unlinked items successfully";
}
Author
Volker Krause vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g
Since
4.2
See also
LinkJob

Definition at line 64 of file unlinkjob.h.

Constructor & Destructor Documentation

UnlinkJob::UnlinkJob ( const Collection &  collection,
const Item::List &  items,
QObject *  parent = 0 
)

Creates a new unlink job.

The job will remove references to the given items from the given collection.

Parameters
collectionThe collection from which the references should be removed.
itemsThe items of which the references should be removed.
parentThe parent object.

Definition at line 34 of file unlinkjob.cpp.

UnlinkJob::~UnlinkJob ( )

Destroys the unlink job.

Definition at line 42 of file unlinkjob.cpp.

Member Function Documentation

void UnlinkJob::doStart ( )
protectedvirtual

This method must be reimplemented in the concrete jobs.

It will be called after the job has been started and a connection to the Akonadi backend has been established.

Implements Akonadi::Job.

Definition at line 46 of file unlinkjob.cpp.


The documentation for this class was generated from the following files:
  • unlinkjob.h
  • unlinkjob.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:00:29 by doxygen 1.8.7 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 API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kldap
  • kmbox
  • kmime
  • kpimidentities
  • kpimtextedit
  • kresources
  • ktnef
  • kxmlrpcclient
  • microblog

Search



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