Contents

Akonadi::ItemDeleteJob Class

class Akonadi::ItemDeleteJob

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

Header: #include <Akonadi/ItemDeleteJob>
CMake: find_package(KPim6 REQUIRED COMPONENTS AkonadiCore)
target_link_libraries(mytarget PRIVATE KPim6::AkonadiCore)
Inherits: Akonadi::Job

Public Functions

ItemDeleteJob(const Akonadi::Tag &tag, QObject *parent = nullptr)
ItemDeleteJob(const Akonadi::Item &item, const Akonadi::Collection &collection, QObject *parent = nullptr)
ItemDeleteJob(const Akonadi::Item::List &items, const Akonadi::Collection &collection, QObject *parent = nullptr)
virtual ~ItemDeleteJob() override
Akonadi::Item::List deletedItems() const

Detailed Description

This job removes the given items from the Akonadi storage.

Example:

 const Akonadi::Item item = ...

 ItemDeleteJob *job = new ItemDeleteJob(item);
 connect(job, &KJob::result, this, &MyClass::deletionResult);

Example:

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

 ItemDeleteJob *job = new ItemDeleteJob(items);
 connect(job, &KJob::result, this, &MyClass::deletionResult);

Author: Volker Krause <vkrause@kde.org>

Member Function Documentation

[explicit] ItemDeleteJob::ItemDeleteJob(const Akonadi::Tag &tag, QObject *parent = nullptr)

Creates a new item delete job that deletes all items that have assigned the tag tag.

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

[explicit] ItemDeleteJob::ItemDeleteJob(const Akonadi::Item &item, const Akonadi::Collection &collection, QObject *parent = nullptr)

Creates a new item delete job that deletes item in the given collection. The item needs to have a unique identifier or a remote identifier set.

item The item to delete. collection The collection context parent The parent object.

[explicit] ItemDeleteJob::ItemDeleteJob(const Akonadi::Item::List &items, const Akonadi::Collection &collection, QObject *parent = nullptr)

Creates a new item delete job that deletes all items of the collection collection in the list items. Each item needs to have a unique identifier or a remote identifier set.

items The items to delete. collection the collection context parent The parent object.

[override virtual noexcept] ItemDeleteJob::~ItemDeleteJob()

Destroys the item delete job.

Akonadi::Item::List ItemDeleteJob::deletedItems() const

Returns the items passed on in the constructor.