Akonadi::CollectionAttributesSynchronizationJob Class

class Akonadi::CollectionAttributesSynchronizationJob

Job that synchronizes the attributes of a collection. More...

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

Public Functions

CollectionAttributesSynchronizationJob(const Akonadi::Collection &collection, QObject *parent = nullptr)
virtual ~CollectionAttributesSynchronizationJob() override

Detailed Description

This job will trigger a resource to synchronize the attributes of a collection based on what the backend is reporting to store them in the Akonadi storage.

Example:

 using namespace Akonadi;

 const Collection collection = ...;

 auto job = new CollectionAttributesSynchronizationJob(collection);
 connect(job, &KJob::result, this, &MyClass::synchronizationFinished);

Note: This is a KJob not an Akonadi::Job, so it won't auto-start!

Author: Volker Krause <vkrause@kde.org>

Member Function Documentation

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

Creates a new synchronization job for the given collection.

collection The collection to synchronize.

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

Destroys the synchronization job.