Akonadi::SpecialCollectionsRequestJob Class Reference

#include <specialcollectionsrequestjob.h>

Inheritance diagram for Akonadi::SpecialCollectionsRequestJob:

Public Member Functions
	~SpecialCollectionsRequestJob ()
Collection	collection () const
void	requestCollection (const QByteArray &type, const AgentInstance &instance)
void	requestDefaultCollection (const QByteArray &type)
Public Member Functions inherited from Akonadi::TransactionSequence
	TransactionSequence (QObject *parent=0)
	~TransactionSequence ()
void	commit ()
void	rollback ()
void	setAutomaticCommittingEnabled (bool enable)
void	setIgnoreJobFailure (KJob *job)
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=0)
virtual	~Job ()
virtual QString	errorString () const
void	start ()

Protected Member Functions
	SpecialCollectionsRequestJob (SpecialCollections *collections, QObject *parent=0)
virtual void	doStart ()
void	setDefaultResourceOptions (const QVariantMap &options)
void	setDefaultResourceType (const QString &type)
void	setIconForTypeMap (const QMap< QByteArray, QString > &map)
void	setNameForTypeMap (const QMap< QByteArray, QString > &map)
void	setTypes (const QList< QByteArray > &types)
virtual void	slotResult (KJob *job)
Protected Member Functions inherited from Akonadi::TransactionSequence
bool	addSubjob (KJob *job)
void	doStart ()
Protected Member Functions inherited from Akonadi::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::TransactionSequence
void	slotResult (KJob *job)
Protected Slots inherited from Akonadi::Job

Detailed Description

A job to request SpecialCollections.

Use this job to request the SpecialCollections you need. You can request both default SpecialCollections and SpecialCollections in a given resource. The default SpecialCollections resource is created when the first default SpecialCollection is requested, but if a SpecialCollection in a custom resource is requested, this job expects that resource to exist already.

If the folders you requested already exist, this job simply succeeds. Otherwise, it creates the required collections and registers them with SpecialCollections.

This class is not meant to be used directly but as a base class for type specific special collection request jobs.

Author

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

Since

4.4

Definition at line 54 of file specialcollectionsrequestjob.h.

Constructor & Destructor Documentation

SpecialCollectionsRequestJob::~SpecialCollectionsRequestJob

(

)

Destroys the special collections request job.

Definition at line 285 of file specialcollectionsrequestjob.cpp.

SpecialCollectionsRequestJob::SpecialCollectionsRequestJob ( SpecialCollections *  collections, QObject *  parent = 0  )

explicitprotected

Creates a new special collections request job.

Parameters

collections	The SpecialCollections object that shall be used.
parent	The parent object.

Definition at line 278 of file specialcollectionsrequestjob.cpp.

Member Function Documentation

Akonadi::Collection SpecialCollectionsRequestJob::collection

(

)

const

Returns the requested collection.

Definition at line 304 of file specialcollectionsrequestjob.cpp.

void SpecialCollectionsRequestJob::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.

Definition at line 337 of file specialcollectionsrequestjob.cpp.

void SpecialCollectionsRequestJob::requestCollection	(	const QByteArray &	type,
		const AgentInstance &	instance
	)

Requests a special collection of the given type in the given resource instance.

Definition at line 297 of file specialcollectionsrequestjob.cpp.

void SpecialCollectionsRequestJob::requestDefaultCollection

(

const QByteArray &

type

)

Requests a special collection of the given type in the default resource.

Definition at line 290 of file specialcollectionsrequestjob.cpp.

void SpecialCollectionsRequestJob::setDefaultResourceOptions ( const QVariantMap &  options )

protected

Sets the configuration options that shall be applied to the new resource that is created if the requested special collection does not exist yet.

Definition at line 317 of file specialcollectionsrequestjob.cpp.

void SpecialCollectionsRequestJob::setDefaultResourceType ( const QString &  type )

protected

Sets the type of the resource that shall be created if the requested special collection does not exist yet.

Definition at line 312 of file specialcollectionsrequestjob.cpp.

void SpecialCollectionsRequestJob::setIconForTypeMap ( const QMap< QByteArray, QString > &  map )

protected

Sets the map of special collection types to icon names.

Definition at line 332 of file specialcollectionsrequestjob.cpp.

void SpecialCollectionsRequestJob::setNameForTypeMap ( const QMap< QByteArray, QString > &  map )

protected

Sets the map of special collection types to display names.

Definition at line 327 of file specialcollectionsrequestjob.cpp.

void SpecialCollectionsRequestJob::setTypes ( const QList< QByteArray > &  types )

protected

Sets the list of well known special collection types.

Definition at line 322 of file specialcollectionsrequestjob.cpp.

---

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

• specialcollectionsrequestjob.h
• specialcollectionsrequestjob.cpp