akonadi
Akonadi::ItemCreateJob Class Reference
Job that creates a new item in the Akonadi storage. More...
#include <itemcreatejob.h>

Public Member Functions | |
ItemCreateJob (const Item &item, const Collection &collection, QObject *parent=0) | |
~ItemCreateJob () | |
Item | item () const |
Protected Member Functions | |
virtual void | doHandleResponse (const QByteArray &tag, const QByteArray &data) |
virtual void | doStart () |
Detailed Description
Job that creates a new item in the Akonadi storage.
This job creates a new item with all the set properties in the given target collection.
Example:
// Create a contact item in the root collection KABC::Addressee addr; addr.setNameFromString( "Joe Jr. Miller" ); Akonadi::Item item; item.setMimeType( "text/directory" ); item.setPayload<KABC::Addressee>( addr ); Akonadi::Collection collection = Akonadi::Collection::root(); Akonadi::ItemCreateJob *job = new Akonadi::ItemCreateJob( item, collection ); connect( job, SIGNAL( result( KJob* ) ), SLOT( jobFinished( KJob* ) ) ); ... MyClass::jobFinished( KJob *job ) { if ( job->error() ) qDebug() << "Error occurred"; else qDebug() << "Contact item created successfully"; }
Definition at line 69 of file itemcreatejob.h.
Constructor & Destructor Documentation
Akonadi::ItemCreateJob::ItemCreateJob | ( | const Item & | item, | |
const Collection & | collection, | |||
QObject * | parent = 0 | |||
) |
Creates a new item create job.
- Parameters:
-
item The item to create.
- Note:
- It must have a mime type set.
- Parameters:
-
collection The parent collection where the new item shall be located in. parent The parent object.
Akonadi::ItemCreateJob::~ItemCreateJob | ( | ) |
Destroys the item create job.
Member Function Documentation
virtual void Akonadi::ItemCreateJob::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.
virtual void Akonadi::ItemCreateJob::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.
Item Akonadi::ItemCreateJob::item | ( | ) | const |
Returns the created item with the new unique id, or an invalid item if the job failed.
The documentation for this class was generated from the following file: