akonadi
#include <itemdeletejob.h>

Public Member Functions | |
ItemDeleteJob (const Collection &collection, QObject *parent=0) | |
ItemDeleteJob (const Item &item, QObject *parent=0) | |
ItemDeleteJob (const Item::List &items, QObject *parent=0) | |
ItemDeleteJob (const Tag &tag, QObject *parent=0) | |
~ItemDeleteJob () | |
Item::List | deletedItems () const |
![]() | |
Job (QObject *parent=0) | |
virtual | ~Job () |
virtual QString | errorString () const |
void | start () |
Protected Member Functions | |
virtual void | doStart () |
![]() | |
virtual bool | addSubjob (KJob *job) |
virtual void | doHandleResponse (const QByteArray &tag, const QByteArray &data) |
virtual bool | doKill () |
virtual void | doStart ()=0 |
void | emitWriteFinished () |
virtual bool | removeSubjob (KJob *job) |
Additional Inherited Members | |
![]() | |
enum | Error { ConnectionFailed = UserDefinedError , ProtocolVersionMismatch , UserCanceled , Unknown , UserError = UserDefinedError + 42 } |
typedef QList< Job * > | List |
![]() | |
void | aboutToStart (Akonadi::Job *job) |
void | writeFinished (Akonadi::Job *job) |
![]() | |
virtual void | slotResult (KJob *job) |
Detailed Description
Job that deletes items from the Akonadi storage.
This job removes the given items from the Akonadi storage.
Example:
Example:
Definition at line 62 of file itemdeletejob.h.
Constructor & Destructor Documentation
◆ ItemDeleteJob() [1/4]
|
explicit |
Creates a new item delete job that deletes item
.
The item needs to have a unique identifier set.
For internal use only, the item may have a remote identifier set instead of a unique identifier. In this 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 49 of file itemdeletejob.cpp.
◆ ItemDeleteJob() [2/4]
|
explicit |
Creates a new item delete job that deletes all items in the list items
.
Each item needs to have a unique identifier set. These items can be located in any collection.
For internal use only, the items may have remote identifiers set instead of unique identifiers. In this case, a collection or resource context needs to be selected using CollectionSelectJob or ResourceSelectJob.
- Parameters
-
items The items to delete. parent The parent object.
- Since
- 4.3
Definition at line 57 of file itemdeletejob.cpp.
◆ ItemDeleteJob() [3/4]
|
explicit |
Creates a new item delete job that deletes all items in the collection collection
.
The collection needs to have a unique identifier set.
For internal use only, the collection may have a remote identifier set instead of a unique identifier. In this 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 65 of file itemdeletejob.cpp.
◆ ItemDeleteJob() [4/4]
|
explicit |
Creates a new item delete job that deletes all items that have assigned the tag tag
.
- Parameters
-
tag The tag which content should be deleted. parent The parent object.
- Since
- 4.14
Definition at line 73 of file itemdeletejob.cpp.
◆ ~ItemDeleteJob()
ItemDeleteJob::~ItemDeleteJob | ( | ) |
Destroys the item delete job.
Definition at line 81 of file itemdeletejob.cpp.
Member Function Documentation
◆ deletedItems()
Item::List ItemDeleteJob::deletedItems | ( | ) | const |
Returns the items passed on in the constructor.
- Since
- 4.4
Definition at line 85 of file itemdeletejob.cpp.
◆ 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 92 of file itemdeletejob.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.