Akonadi::CollectionStatistics

Akonadi::CollectionStatistics Class Reference

#include <collectionstatistics.h>

Public Member Functions

 CollectionStatistics ()
 
 CollectionStatistics (const CollectionStatistics &other)
 
 ~CollectionStatistics ()
 
qint64 count () const
 
CollectionStatisticsoperator= (const CollectionStatistics &other)
 
void setCount (qint64 count)
 
void setSize (qint64 size)
 
void setUnreadCount (qint64 count)
 
qint64 size () const
 
qint64 unreadCount () const
 

Detailed Description

Provides statistics information of a Collection.

This class contains information such as total number of items, number of new and unread items, etc.

This information might be expensive to obtain and is thus not included when fetching collections with a CollectionFetchJob. It can be retrieved separately using CollectionStatisticsJob.

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();
}

This class is implicitly shared.

Author
Volker Krause vkrau[email protected][email protected][email protected]de.or[email protected]g

Definition at line 71 of file core/collectionstatistics.h.

Constructor & Destructor Documentation

CollectionStatistics::CollectionStatistics ( )

Creates a new collection statistics object.

Definition at line 51 of file core/collectionstatistics.cpp.

CollectionStatistics::CollectionStatistics ( const CollectionStatistics other)

Creates a collection statistics object from an other one.

Definition at line 56 of file core/collectionstatistics.cpp.

CollectionStatistics::~CollectionStatistics ( )

Destroys the collection statistics object.

Definition at line 61 of file core/collectionstatistics.cpp.

Member Function Documentation

qint64 CollectionStatistics::count ( ) const

Returns the number of items in this collection or -1 if this information is not available.

See also
setCount()
unreadCount()

Definition at line 65 of file core/collectionstatistics.cpp.

CollectionStatistics & CollectionStatistics::operator= ( const CollectionStatistics other)

Assigns other to this statistics object and returns a reference to this one.

Definition at line 95 of file core/collectionstatistics.cpp.

void CollectionStatistics::setCount ( qint64  count)

Sets the number of items in this collection.

Parameters
countThe number of items.
See also
count()

Definition at line 70 of file core/collectionstatistics.cpp.

void CollectionStatistics::setSize ( qint64  size)

Sets the total size of the items in this collection.

Parameters
sizeThe total size of the items
See also
size()
Since
4.3

Definition at line 90 of file core/collectionstatistics.cpp.

void CollectionStatistics::setUnreadCount ( qint64  count)

Sets the number of unread items in this collection.

Parameters
countThe number of unread messages.
See also
unreadCount()

Definition at line 80 of file core/collectionstatistics.cpp.

qint64 CollectionStatistics::size ( ) const

Returns the total size of the items in this collection or -1 if this information is not available.

See also
setSize()
Since
4.3

Definition at line 85 of file core/collectionstatistics.cpp.

qint64 CollectionStatistics::unreadCount ( ) const

Returns the number of unread items in this collection or -1 if this information is not available.

See also
setUnreadCount()
count()

Definition at line 75 of file core/collectionstatistics.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Jun 6 2020 23:09:07 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.