akonadi
#include <specialcollectionshelperjobs_p.h>

Public Member Functions | |
ResourceScanJob (const QString &resourceId, KCoreConfigSkeleton *settings, QObject *parent=0) | |
~ResourceScanJob () | |
QString | resourceId () const |
Akonadi::Collection | rootResourceCollection () const |
void | setResourceId (const QString &resourceId) |
Akonadi::Collection::List | specialCollections () const |
Protected Member Functions | |
virtual void | doStart () |
Detailed Description
Helper job for SpecialCollectionsRequestJob.
A Job that fetches all the collections of a resource, and returns only those that have a SpecialCollectionAttribute.
- Since:
- 4.4
Definition at line 45 of file specialcollectionshelperjobs_p.h.
Constructor & Destructor Documentation
ResourceScanJob::ResourceScanJob | ( | const QString & | resourceId, |
KCoreConfigSkeleton * | settings, | ||
QObject * | parent = 0 |
||
) | [explicit] |
Creates a new ResourceScanJob.
Definition at line 155 of file specialcollectionshelperjobs.cpp.
ResourceScanJob::~ResourceScanJob | ( | ) |
Destroys this ResourceScanJob.
Definition at line 162 of file specialcollectionshelperjobs.cpp.
Member Function Documentation
void ResourceScanJob::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.
Reimplemented in Akonadi::DefaultResourceJob.
Definition at line 187 of file specialcollectionshelperjobs.cpp.
QString ResourceScanJob::resourceId | ( | ) | const |
Returns the resource ID of the resource being scanned.
Definition at line 167 of file specialcollectionshelperjobs.cpp.
Akonadi::Collection ResourceScanJob::rootResourceCollection | ( | ) | const |
Returns the root collection of the resource being scanned.
This function relies on there being a single top-level collection owned by this resource.
Definition at line 177 of file specialcollectionshelperjobs.cpp.
void ResourceScanJob::setResourceId | ( | const QString & | resourceId | ) |
Sets the resource ID of the resource to scan.
Definition at line 172 of file specialcollectionshelperjobs.cpp.
Akonadi::Collection::List ResourceScanJob::specialCollections | ( | ) | const |
Returns all the collections of this resource which have a SpecialCollectionAttribute.
These might include the root resource collection.
Definition at line 182 of file specialcollectionshelperjobs.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Thu May 10 2012 22:18:42 by doxygen 1.8.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.