akonadi
#include <itemdeletejob.h>

Public Member Functions | |
ItemDeleteJob (const Item &item, QObject *parent=0) | |
ItemDeleteJob (const Item::List &items, QObject *parent=0) | |
ItemDeleteJob (const Collection &collection, QObject *parent=0) | |
~ItemDeleteJob () | |
Item::List | deletedItems () const |
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* ) ) );
Definition at line 62 of file itemdeletejob.h.
Constructor & Destructor Documentation
Akonadi::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.
Akonadi::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
Akonadi::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
ItemDeleteJob::~ItemDeleteJob | ( | ) |
Destroys the item delete job.
Definition at line 85 of file itemdeletejob.cpp.
Member Function Documentation
Item::List ItemDeleteJob::deletedItems | ( | ) | const |
Returns the items passed on in the constructor.
- Since:
- 4.4
Definition at line 89 of file itemdeletejob.cpp.
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 96 of file itemdeletejob.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Tue May 8 2012 00:00:50 by doxygen 1.8.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.