Akonadi::UnlinkJob Class Reference

Job that unlinks items inside the Akonadi storage. More...

#include <unlinkjob.h>

Inheritance diagram for Akonadi::UnlinkJob:

[legend]

List of all members.

Public Member Functions
	UnlinkJob (const Collection &collection, const Item::List &items, QObject *parent=0)
	~UnlinkJob ()
Protected Member Functions
void	doStart ()

---

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 <vkrause@kde.org>

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:

	collection	The collection from which the references should be removed.
	items	The items of which the references should be removed.
	parent	The 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

(

)

[protected, virtual]

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