akonadi
Akonadi::CollectionCreateJob Class Reference
Job that creates a new collection in the Akonadi storage. More...
#include <collectioncreatejob.h>

Public Member Functions | |
Collection | collection () const |
CollectionCreateJob (const Collection &collection, QObject *parent=0) | |
virtual | ~CollectionCreateJob () |
Protected Member Functions | |
virtual void | doHandleResponse (const QByteArray &tag, const QByteArray &data) |
virtual void | doStart () |
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.setParent( Collection::root() ); collection.setName( "Events" ); collection.setContentMimeTypes( QStringList( "text/calendar" ) ); Akonadi::CollectionCreateJob *job = new Akonadi::CollectionCreateJob( collection ); if ( job->exec() ) qDebug() << "Created successfully"; else qDebug() << "Error occurred";
Definition at line 55 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. parent The parent object.
Definition at line 41 of file collectioncreatejob.cpp.
CollectionCreateJob::~CollectionCreateJob | ( | ) | [virtual] |
Member Function Documentation
Collection CollectionCreateJob::collection | ( | ) | const |
Returns the created collection if the job was executed succesfull.
Definition at line 75 of file collectioncreatejob.cpp.
void CollectionCreateJob::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 82 of file collectioncreatejob.cpp.
void CollectionCreateJob::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 53 of file collectioncreatejob.cpp.
The documentation for this class was generated from the following files: