akonadi
#include <collectionfetchjob.h>

Public Types | |
enum | Type { Base, FirstLevel, Recursive, NonOverlappingRoots } |
Signals | |
void | collectionsReceived (const Akonadi::Collection::List &collections) |
Public Member Functions | |
CollectionFetchJob (const Collection &collection, Type type=FirstLevel, QObject *parent=0) | |
CollectionFetchJob (const Collection::List &collections, QObject *parent=0) | |
CollectionFetchJob (const Collection::List &collections, Type type, QObject *parent=0) | |
CollectionFetchJob (const QList< Collection::Id > &collections, Type type=Base, QObject *parent=0) | |
virtual | ~CollectionFetchJob () |
Collection::List | collections () const |
CollectionFetchScope & | fetchScope () |
void | includeStatistics (bool include=true) |
void | includeUnsubscribed (bool include=true) |
void | setFetchScope (const CollectionFetchScope &fetchScope) |
void | setResource (const QString &resource) |
Protected Member Functions | |
virtual void | doHandleResponse (const QByteArray &tag, const QByteArray &data) |
virtual void | doStart () |
Detailed Description
Job that fetches collections from the Akonadi storage.
This class can be used to retrieve the complete or partial collection tree from the Akonadi storage. This fetches collection data, not item data.
using namespace Akonadi; // fetching all collections containing emails recursively, starting at the root collection CollectionFetchJob *job = new CollectionFetchJob( Collection::root(), CollectionFetchJob::Recursive, this ); job->fetchScope().setContentMimeTypes( QStringList() << "message/rfc822" ); connect( job, SIGNAL( collectionsReceived( const Akonadi::Collection::List& ) ), this, SLOT( myCollectionsReceived( const Akonadi::Collection::List& ) ) ); connect( job, SIGNAL( result( KJob* ) ), this, SLOT( collectionFetchResult( KJob* ) ) );
Definition at line 53 of file collectionfetchjob.h.
Member Enumeration Documentation
enum Akonadi::CollectionFetchJob::Type |
Describes the type of fetch depth.
- Enumerator:
Definition at line 61 of file collectionfetchjob.h.
Constructor & Destructor Documentation
Akonadi::CollectionFetchJob::CollectionFetchJob | ( | const Collection & | collection, |
Type | type = FirstLevel , |
||
QObject * | parent = 0 |
||
) | [explicit] |
Creates a new collection fetch job.
If the given base collection has a unique identifier, this is used to identify the collection in the Akonadi server. If only a remote identifier is avaiable the collection is identified using that, provided that a resource search context has been specified. There are two ways of doing that: by calling setResource(), or globally using Akonadi::ResourceSelectJob.
- Parameters:
-
collection The base collection for the listing. type The type of fetch depth. parent The parent object.
Akonadi::CollectionFetchJob::CollectionFetchJob | ( | const Collection::List & | collections, |
QObject * | parent = 0 |
||
) | [explicit] |
Creates a new collection fetch job to retrieve a list of collections.
The same rules for identifiers apply as noted in the constructor description.
- Parameters:
-
collections A list of collections to fetch. Must not be empty. parent The parent object.
Akonadi::CollectionFetchJob::CollectionFetchJob | ( | const Collection::List & | collections, |
Type | type, | ||
QObject * | parent = 0 |
||
) |
Creates a new collection fetch job to retrieve a list of collections.
The same rules for identifiers apply as noted in the constructor description.
- Parameters:
-
collections A list of collections to fetch. Must not be empty. type The type of fetch depth. parent The parent object.
- Todo:
- KDE5 merge with ctor above.
- Since:
- 4.7
Akonadi::CollectionFetchJob::CollectionFetchJob | ( | const QList< Collection::Id > & | collections, |
Type | type = Base , |
||
QObject * | parent = 0 |
||
) | [explicit] |
Convenience ctor equivalent to CollectionFetchJob( const Collection::List &collections, Type type, QObject *parent = 0 )
- Since:
- 4.8
CollectionFetchJob::~CollectionFetchJob | ( | ) | [virtual] |
Destroys the collection fetch job.
Definition at line 156 of file collectionfetchjob.cpp.
Member Function Documentation
Akonadi::Collection::List CollectionFetchJob::collections | ( | ) | const |
Returns the list of fetched collection.
Definition at line 160 of file collectionfetchjob.cpp.
void Akonadi::CollectionFetchJob::collectionsReceived | ( | const Akonadi::Collection::List & | collections | ) | [signal] |
This signal is emitted whenever the job has received collections.
- Parameters:
-
collections The received collections.
void CollectionFetchJob::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.
Definition at line 282 of file collectionfetchjob.cpp.
void CollectionFetchJob::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.
Definition at line 167 of file collectionfetchjob.cpp.
CollectionFetchScope & CollectionFetchJob::fetchScope | ( | ) |
Returns the collection fetch scope.
Since this returns a reference it can be used to conveniently modify the current scope in-place, i.e. by calling a method on the returned reference without storing it in a local variable. See the CollectionFetchScope documentation for an example.
- Returns:
- a reference to the current collection fetch scope
- See also:
- setFetchScope() for replacing the current collection fetch scope
- Since:
- 4.4
Definition at line 413 of file collectionfetchjob.cpp.
void CollectionFetchJob::includeStatistics | ( | bool | include = true | ) |
Include also statistics about the collections.
- Since:
- 4.3
- Deprecated:
- Use CollectionFetchScope instead.
Definition at line 400 of file collectionfetchjob.cpp.
void CollectionFetchJob::includeUnsubscribed | ( | bool | include = true | ) |
Include also unsubscribed collections.
- Deprecated:
- Use CollectionFetchScope instead.
Definition at line 393 of file collectionfetchjob.cpp.
void CollectionFetchJob::setFetchScope | ( | const CollectionFetchScope & | fetchScope | ) |
Sets the collection fetch scope.
The CollectionFetchScope controls how much of a collection's data is fetched from the server as well as a filter to select which collections to fetch.
- Parameters:
-
fetchScope The new scope for collection fetch operations.
- See also:
- fetchScope()
- Since:
- 4.4
Definition at line 407 of file collectionfetchjob.cpp.
void CollectionFetchJob::setResource | ( | const QString & | resource | ) |
Sets a resource identifier to limit collection listing to one resource.
- Parameters:
-
resource The resource identifier.
- Deprecated:
- Use CollectionFetchScope instead.
Definition at line 305 of file collectionfetchjob.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Tue May 8 2012 00:00:48 by doxygen 1.8.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.