Akonadi::ItemDeleteJob Class Reference

Job that deletes items from the Akonadi storage. More...

#include <itemdeletejob.h>

Inheritance diagram for Akonadi::ItemDeleteJob:

[legend]

List of all members.

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

---

Detailed Description

Job that deletes items from the Akonadi storage.

This job removes the given items from the Akonadi storage.

Example:

 const Akonadi::Item item = ...

 ItemDeleteJob *job = new ItemDeleteJob( item );
 connect( job, SIGNAL( result( KJob* ) ), this, SLOT( deletionResult( KJob* ) ) );

Example:

 const Akonadi::Item::List items = ...

 ItemDeleteJob *job = new ItemDeleteJob( items );
 connect( job, SIGNAL( result( KJob* ) ), this, SLOT( deletionResult( KJob* ) ) );

Author:

Volker Krause <vkrause@kde.org>

Definition at line 62 of file itemdeletejob.h.

---

Constructor & Destructor Documentation

ItemDeleteJob::ItemDeleteJob	(	const Item &	item,
		QObject *	parent = 0
	)			[explicit]

Creates a new item delete job that deletes item.

The item needs to either have a unique identifier or a remote identifier set. In the latter case a collection or resource context needs to be selected (using CollectionSelectJob or ResourceSelectJob).

Parameters:

	item	The item to delete.
	parent	The parent object.

Definition at line 61 of file itemdeletejob.cpp.

ItemDeleteJob::ItemDeleteJob	(	const Item::List &	items,
		QObject *	parent = 0
	)			[explicit]

Creates a new item delete job that deletes all items in the list items.

These items can be located in any collection. The same restrictions on item identifiers apply as in the constructor above.

Parameters:

	items	The items to delete.
	parent	The parent object.

Since:

4.3

Definition at line 69 of file itemdeletejob.cpp.

ItemDeleteJob::ItemDeleteJob	(	const Collection &	collection,
		QObject *	parent = 0
	)			[explicit]

Creates a new item delete job that deletes all items in the collection collection.

The collection needs to have either a unique identifier or a remote identifier set. In the latter case a resource context needs to be selected using ResourceSelectJob.

Parameters:

	collection	The collection which content should be deleted.
	parent	The parent object.

Since:

4.3

Definition at line 76 of file itemdeletejob.cpp.

ItemDeleteJob::~ItemDeleteJob

(

)

Destroys the item delete job.

Definition at line 83 of file itemdeletejob.cpp.

---

Member Function Documentation

void ItemDeleteJob::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 87 of file itemdeletejob.cpp.

---

The documentation for this class was generated from the following files:

• itemdeletejob.h
• itemdeletejob.cpp