akonadi
#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.
Note that items can not be created in the root collection (Collection::root()) and the collection must have Collection::contentMimeTypes() that match the mimetype of the item being created.
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 = getCollection(); 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 73 of file itemcreatejob.h.
Constructor & Destructor Documentation
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.
Definition at line 52 of file itemcreatejob.cpp.
ItemCreateJob::~ItemCreateJob | ( | ) |
Destroys the item create job.
Definition at line 63 of file itemcreatejob.cpp.
Member Function Documentation
void 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.
Definition at line 124 of file itemcreatejob.cpp.
void 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.
Definition at line 67 of file itemcreatejob.cpp.
Item ItemCreateJob::item | ( | ) | const |
Returns the created item with the new unique id, or an invalid item if the job failed.
Definition at line 155 of file itemcreatejob.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Tue May 8 2012 00:00:50 by doxygen 1.8.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.