Akonadi::CollectionCreateJob Class Reference

#include <collectioncreatejob.h>

Inheritance diagram for Akonadi::CollectionCreateJob:

Public Member Functions
	CollectionCreateJob (const Collection &collection, QObject *parent=0)
virtual	~CollectionCreateJob ()
Collection	collection () 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	doHandleResponse (const QByteArray &tag, const QByteArray &data)
virtual void	doStart ()
Protected Member Functions inherited from Akonadi::Job
virtual bool	addSubjob (KJob *job)
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

Job that creates a new collection in the Akonadi storage.

This job creates a new collection with all the set properties. You have to use setParentCollection() to define the collection the new collection shall be located in.

// create a new top-level collection
Akonadi::Collection collection;
collection.setParentCollection( Collection::root() );
collection.setName( "Events" );
collection.setContentMimeTypes( QStringList( "text/calendar" ) );

Akonadi::CollectionCreateJob *job = new Akonadi::CollectionCreateJob( collection );
connect( job, SIGNAL(result(KJob*)), this, SLOT(createResult(KJob*)) );

Author

Volker Krause vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

Definition at line 52 of file collectioncreatejob.h.

Constructor & Destructor Documentation

CollectionCreateJob::CollectionCreateJob ( const Collection &  collection, QObject *  parent = 0  )

explicit

Creates a new collection create job.

Parameters

collection	The new collection. collection must have a parent collection set with a unique identifier. If a resource context is specified in the current session (that is you are using it within Akonadi::ResourceBase), the parent collection can be identified by its remote identifier as well.
parent	The parent object.

Definition at line 41 of file collectioncreatejob.cpp.

CollectionCreateJob::~CollectionCreateJob ( )

virtual

Destroys the collection create job.

Definition at line 49 of file collectioncreatejob.cpp.

Member Function Documentation

Collection CollectionCreateJob::collection

(

)

const

Returns the created collection if the job was executed successfully.

Definition at line 97 of file collectioncreatejob.cpp.

void CollectionCreateJob::doHandleResponse ( const QByteArray &  tag, const QByteArray &  data  )

protectedvirtual

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 104 of file collectioncreatejob.cpp.

void CollectionCreateJob::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 53 of file collectioncreatejob.cpp.

---

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

• collectioncreatejob.h
• collectioncreatejob.cpp