Akonadi::CollectionStatisticsJob Class Reference

#include <collectionstatisticsjob.h>

Inheritance diagram for Akonadi::CollectionStatisticsJob:

Public Member Functions
	CollectionStatisticsJob (const Collection &collection, QObject *parent=0)
virtual	~CollectionStatisticsJob ()
Collection	collection () const
CollectionStatistics	statistics () const
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=0)
virtual	~Job ()
virtual QString	errorString () const
void	start ()

Protected Member Functions
virtual void	doHandleResponse (const QByteArray &tag, const QByteArray &data)
virtual void	doStart ()
Protected Member Functions inherited from Akonadi::Job
virtual bool	addSubjob (KJob *job)
virtual bool	doKill ()
void	emitWriteFinished ()
virtual bool	removeSubjob (KJob *job)

Additional Inherited Members
Public Types inherited from Akonadi::Job
enum	Error {   ConnectionFailed = UserDefinedError, ProtocolVersionMismatch, UserCanceled, Unknown,   UserError = UserDefinedError + 42 }
typedef QList< Job * >	List
Signals inherited from Akonadi::Job
void	aboutToStart (Akonadi::Job *job)
void	writeFinished (Akonadi::Job *job)
Protected Slots inherited from Akonadi::Job
virtual void	slotResult (KJob *job)

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 );
connect( job, SIGNAL( result( KJob* ) ), SLOT( jobFinished( KJob* ) ) );

...

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 vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

Definition at line 66 of file collectionstatisticsjob.h.

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 47 of file collectionstatisticsjob.cpp.

CollectionStatisticsJob::~CollectionStatisticsJob ( )

virtual

Destroys the collection statistics job.

Definition at line 55 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 98 of file collectionstatisticsjob.cpp.

void CollectionStatisticsJob::doHandleResponse ( const QByteArray &  tag, const QByteArray &  data  )

protectedvirtual

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 66 of file collectionstatisticsjob.cpp.

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

CollectionStatistics Akonadi::CollectionStatisticsJob::statistics

(

)

const

Returns the fetched collection statistics.

Definition at line 105 of file collectionstatisticsjob.cpp.

---

The documentation for this class was generated from the following files:

• collectionstatisticsjob.h
• collectionstatisticsjob.cpp