Akonadi::CollectionStatisticsJob Class

class Akonadi::CollectionStatisticsJob

Job that fetches collection statistics from the Akonadi storage. More...

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

List of all members, including inherited members

Public Functions

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

Detailed Description

This class fetches the CollectionStatistics object for a given collection.

Example:

 Akonadi::Collection collection = ...

 Akonadi::CollectionStatisticsJob *job = new Akonadi::CollectionStatisticsJob( collection );
 connect(job, &KJob::result, this, &MyClass::jobFinished);

 ...

 MyClass::jobFinished( KJob *job )
 {
   if ( job->error() ) {
     qDebug() << "Error occurred";
     return;
   }

   CollectionStatisticsJob *statisticsJob = qobject_cast<CollectionStatisticsJob*>( job );

   const Akonadi::CollectionStatistics statistics = statisticsJob->statistics();
   qDebug() << "Unread items:" << statistics.unreadCount();
 }

Author: Volker Krause <vkrause@kde.org>

Member Function Documentation

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

Creates a new collection statistics job.

collection The collection to fetch the statistics from. parent The parent object.

`[override virtual noexcept]` CollectionStatisticsJob::~CollectionStatisticsJob()

Destroys the collection statistics job.

Akonadi::Collection CollectionStatisticsJob::collection() const

Returns the corresponding collection, if the job was executed successfully, the collection is already updated.

Akonadi::CollectionStatistics CollectionStatisticsJob::statistics() const

Returns the fetched collection statistics.

Contents