akonadi
Akonadi::CollectionStatistics Class Reference
#include <collectionstatistics.h>
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.
These information might be expensive to obtain and are thus not included when fetching collection with a CollectionFetchJob. They can be retrieved spearately using CollectionStatisticsJob.
Example:
Akonadi::Collection collection = ... Akonadi::CollectionStatisticsJob *job = new Akonadi::CollectionStatisticsJob( collection ); if ( job->exec() ) { Akonadi::CollectionStatistics statistics = job->statistics(); qDebug() << "Unread items:" << statistics.unreadCount(); }
This class is implicitely shared.
Definition at line 57 of file collectionstatistics.h.
Public Member Functions | |
CollectionStatistics (const CollectionStatistics &other) | |
CollectionStatistics () | |
qint64 | count () const |
CollectionStatistics & | operator= (const CollectionStatistics &other) |
void | setCount (qint64 count) |
void | setUnreadCount (qint64 count) |
qint64 | unreadCount () const |
~CollectionStatistics () |
Constructor & Destructor Documentation
CollectionStatistics::CollectionStatistics | ( | ) |
CollectionStatistics::CollectionStatistics | ( | const CollectionStatistics & | other | ) |
Creates a collection statistics object from an other
one.
Definition at line 55 of file collectionstatistics.cpp.
CollectionStatistics::~CollectionStatistics | ( | ) |
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()
Definition at line 64 of file collectionstatistics.cpp.
CollectionStatistics & CollectionStatistics::operator= | ( | const CollectionStatistics & | other | ) |
Assigns other
to this statistics object and returns a reference to this one.
Definition at line 84 of file collectionstatistics.cpp.
void CollectionStatistics::setCount | ( | qint64 | count | ) |
Sets the number of items in this collection.
- Parameters:
-
count The number of items.
- See also:
- count()
Definition at line 69 of file collectionstatistics.cpp.
void CollectionStatistics::setUnreadCount | ( | qint64 | count | ) |
Sets the number of unread items in this collection.
- Parameters:
-
count The number of unread messages.
- See also:
- unreadCount()
Definition at line 79 of file 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()
Definition at line 74 of file collectionstatistics.cpp.
The documentation for this class was generated from the following files: