akonadi
Akonadi::CollectionSelectJob Class Reference
#include <collectionselectjob_p.h>

Public Member Functions | |
CollectionSelectJob (const Collection &collection, QObject *parent=0) | |
virtual | ~CollectionSelectJob () |
void | setRetrieveStatus (bool status) |
int | unseen () const |
Protected Member Functions | |
void | doHandleResponse (const QByteArray &tag, const QByteArray &data) |
void | doStart () |
Detailed Description
For internal use only.
Selects a specific collection. See RFC 3501 for select semantics.
Definition at line 34 of file collectionselectjob_p.h.
Constructor & Destructor Documentation
Akonadi::CollectionSelectJob::CollectionSelectJob | ( | const Collection & | collection, | |
QObject * | parent = 0 | |||
) | [explicit] |
Creates a new collection select job.
When providing a collection with just a remote identifier, make sure to specify in which resource to search for that using Akonadi::ResourceSelectJob.
- Parameters:
-
collection The collection to select. parent The parent object.
virtual Akonadi::CollectionSelectJob::~CollectionSelectJob | ( | ) | [virtual] |
Destroys this job.
Member Function Documentation
void Akonadi::CollectionSelectJob::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.
void Akonadi::CollectionSelectJob::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.
void Akonadi::CollectionSelectJob::setRetrieveStatus | ( | bool | status | ) |
Enable fetching of collection status details.
int Akonadi::CollectionSelectJob::unseen | ( | ) | const |
Returns the unseen count of the selected folder, -1 if not available.
The documentation for this class was generated from the following file: