Akonadi::TrashRestoreJob Class Reference

#include <trashrestorejob.h>

Inheritance diagram for Akonadi::TrashRestoreJob:

Public Member Functions
	TrashRestoreJob (const Item &item, QObject *parent=0)
	TrashRestoreJob (const Item::List &items, QObject *parent=0)
	TrashRestoreJob (const Collection &collection, QObject *parent=0)
Item::List	items () const
void	setTargetCollection (const Collection collection)
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=0)
virtual	~Job ()
virtual QString	errorString () const
void	start ()

Protected Member Functions
virtual void	doStart ()
Protected Member Functions inherited from Akonadi::Job
virtual bool	addSubjob (KJob *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::Job
virtual void	slotResult (KJob *job)

Detailed Description

Job that restores entites from trash.

This job restores the given entites from trash. The EntityDeletedAttribute is removed and the item is restored to the stored restore collection.

If the stored restore collection is not available, the root collection of the original resource is used. If also this is not available, setTargetCollection has to be used to restore the item to a specific collection.

Example:

const Akonadi::Item::List items = ...

TrashRestoreJob *job = new TrashRestoreJob( items );
connect( job, SIGNAL(result(KJob*)), this, SLOT(restoreResult(KJob*)) );

Author

Christian Mollekopf chrig.nosp@m.i_1@.nosp@m.fastm.nosp@m.ail..nosp@m.fm

Since

4.8

Definition at line 56 of file trashrestorejob.h.

Constructor & Destructor Documentation

TrashRestoreJob::TrashRestoreJob ( const Item &  item, QObject *  parent = 0  )

explicit

All items need to be from the same resource.

Definition at line 274 of file trashrestorejob.cpp.

Member Function Documentation

void TrashRestoreJob::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 311 of file trashrestorejob.cpp.

void TrashRestoreJob::setTargetCollection

(

const Collection

collection

)

Sets the target collection, where the item is moved to.

If not set the item will be restored in the collection saved in the EntityDeletedAttribute.

Parameters

collection

the collection to set as target

Definition at line 299 of file trashrestorejob.cpp.

---

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

• trashrestorejob.h
• trashrestorejob.cpp