Akonadi::ResourceScanJob Class Reference

#include <specialcollectionshelperjobs_p.h>

Inheritance diagram for Akonadi::ResourceScanJob:

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
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=0)
virtual	~Job ()
virtual QString	errorString () const
void	start ()

Protected Member Functions
virtual void	doStart ()
Protected Member Functions inherited from Akonadi::Job
virtual bool	addSubjob (KJob *job)
virtual void	doHandleResponse (const QByteArray &tag, const QByteArray &data)
virtual bool	doKill ()
void	emitWriteFinished ()
virtual bool	removeSubjob (KJob *job)

Additional Inherited Members
Public Types inherited from Akonadi::Job
enum	Error {   ConnectionFailed = UserDefinedError, ProtocolVersionMismatch, UserCanceled, Unknown,   UserError = UserDefinedError + 42 }
typedef QList< Job * >	List
Signals inherited from Akonadi::Job
void	aboutToStart (Akonadi::Job *job)
void	writeFinished (Akonadi::Job *job)
Protected Slots inherited from Akonadi::Job
virtual void	slotResult (KJob *job)

Detailed Description

Helper job for SpecialCollectionsRequestJob.

A Job that fetches all the collections of a resource, and returns only those that have a SpecialCollectionAttribute.

Author

Constantin Berzan exit3.nosp@m.219@.nosp@m.gmail.nosp@m..com

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 167 of file specialcollectionshelperjobs.cpp.

ResourceScanJob::~ResourceScanJob

(

)

Destroys this ResourceScanJob.

Definition at line 174 of file specialcollectionshelperjobs.cpp.

Member Function Documentation

void ResourceScanJob::doStart ( )

protectedvirtual

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 199 of file specialcollectionshelperjobs.cpp.

QString ResourceScanJob::resourceId

(

)

const

Returns the resource ID of the resource being scanned.

Definition at line 179 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 189 of file specialcollectionshelperjobs.cpp.

void ResourceScanJob::setResourceId

(

const QString &

resourceId

)

Sets the resource ID of the resource to scan.

Definition at line 184 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 194 of file specialcollectionshelperjobs.cpp.

---

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

• specialcollectionshelperjobs_p.h
• specialcollectionshelperjobs.cpp