• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

Akonadi::CollectionStatisticsJob

Akonadi::CollectionStatisticsJob Class Reference

#include <collectionstatisticsjob.h>

Inheritance diagram for Akonadi::CollectionStatisticsJob:

Inheritance graph
[legend]

List of all members.


Detailed Description

Job that fetches collection statistics from the Akonadi storage.

This class fetches the CollectionStatistics object for a given collection.

Example:

 Akonadi::Collection collection = ...

 Akonadi::CollectionStatisticsJob *job = new Akonadi::CollectionStatisticsJob( collection );
 if ( job->exec() ) {
   Akonadi::CollectionStatistics statistics = job->statistics();
   qDebug() << "Unread items:" << statistics.unreadCount();
 }

Author:
Volker Krause <vkrause@kde.org>

Definition at line 54 of file collectionstatisticsjob.h.


Public Member Functions

Collection collection () const
 CollectionStatisticsJob (const Collection &collection, QObject *parent=0)
CollectionStatistics statistics () const
virtual ~CollectionStatisticsJob ()

Protected Member Functions

virtual void doHandleResponse (const QByteArray &tag, const QByteArray &data)
virtual void doStart ()

Constructor & Destructor Documentation

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

Creates a new collection statistics job.

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

Definition at line 43 of file collectionstatisticsjob.cpp.

CollectionStatisticsJob::~CollectionStatisticsJob (  )  [virtual]

Destroys the collection statistics job.

Definition at line 51 of file collectionstatisticsjob.cpp.


Member Function Documentation

Collection CollectionStatisticsJob::collection (  )  const

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

Definition at line 92 of file collectionstatisticsjob.cpp.

void CollectionStatisticsJob::doHandleResponse ( const QByteArray &  tag,
const QByteArray &  data 
) [protected, virtual]

This method should be reimplemented in the concrete jobs in case you want to handle incoming data.

It will be called on received data from the backend. The default implementation does nothing.

Parameters:
tag The tag of the corresponding command, empty if this is an untagged response.
data The received data.

Reimplemented from Akonadi::Job.

Definition at line 62 of file collectionstatisticsjob.cpp.

void CollectionStatisticsJob::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 55 of file collectionstatisticsjob.cpp.

CollectionStatistics Akonadi::CollectionStatisticsJob::statistics (  )  const

Returns the fetched collection statistics.

Definition at line 99 of file collectionstatisticsjob.cpp.


The documentation for this class was generated from the following files:
  • collectionstatisticsjob.h
  • collectionstatisticsjob.cpp

akonadi

Skip menu "akonadi"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal