Akonadi::CollectionStatistics Class Reference

#include <collectionstatistics.h>

Public Member Functions
	CollectionStatistics ()
	CollectionStatistics (const CollectionStatistics &other)
	~CollectionStatistics ()
qint64	count () const
CollectionStatistics &	operator= (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.nosp@m.se@k.nosp@m.de.or.nosp@m.g

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

Constructor & Destructor Documentation

CollectionStatistics() [1/2]

CollectionStatistics::CollectionStatistics

(

)

Creates a new collection statistics object.

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

CollectionStatistics() [2/2]

CollectionStatistics::CollectionStatistics

(

const CollectionStatistics &

other

)

Creates a collection statistics object from an other one.

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

~CollectionStatistics()

CollectionStatistics::~CollectionStatistics ( )

default

Destroys the collection statistics object.

Member Function Documentation

count()

qint64 CollectionStatistics::count ( ) const

nodiscard

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

See also

setCount()

unreadCount()

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

operator=()

CollectionStatistics & CollectionStatistics::operator=

(

const CollectionStatistics &

other

)

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

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

setCount()

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 42 of file core/collectionstatistics.cpp.

setSize()

void CollectionStatistics::setSize

(

qint64

size

)

Sets the total size of the items in this collection.

Parameters

size	The total size of the items

See also

size()

Since

4.3

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

setUnreadCount()

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 52 of file core/collectionstatistics.cpp.

size()

qint64 CollectionStatistics::size ( ) const

nodiscard

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 57 of file core/collectionstatistics.cpp.

unreadCount()

qint64 CollectionStatistics::unreadCount ( ) const

nodiscard

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

See also

setUnreadCount()

count()

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

---

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

• core/collectionstatistics.h
• core/collectionstatistics.cpp