• Skip to content
  • Skip to link menu
KDE 4.8 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • CollectionDeleteJob
Public Member Functions | Protected Member Functions
Akonadi::CollectionDeleteJob Class Reference

#include <collectiondeletejob.h>

Inheritance diagram for Akonadi::CollectionDeleteJob:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CollectionDeleteJob (const Collection &collection, QObject *parent=0)
 ~CollectionDeleteJob ()

Protected Member Functions

virtual void doStart ()

Detailed Description

Job that deletes a collection in the Akonadi storage.

This job deletes a collection and all its sub-collections as well as all associated content.

 Akonadi::Collection collection = ...

 Akonadi::CollectionDeleteJob *job = new Akonadi::CollectionDeleteJob( collection );
 connect( job, SIGNAL( result( KJob* ) ), this, SLOT( deletionResult( KJob* ) ) );
Note:
This job deletes the data from the backend storage. To delete the collection from the Akonadi storage only, leaving the backend storage unchanged, delete the Agent instead, as follows. (Note that if it's a sub-collection, deleting the agent will also delete its parent collection; in this case the only option is to delete the sub-collection data in both Akonadi and backend storage.)
 const Akonadi::AgentInstance instance =
                   Akonadi::AgentManager::self()->instance( collection.resource() );
 if ( instance.isValid() ) {
   Akonadi::AgentManager::self()->removeInstance( instance );
 }
Author:
Volker Krause <vkrause@kde.org>

Definition at line 63 of file collectiondeletejob.h.


Constructor & Destructor Documentation

CollectionDeleteJob::CollectionDeleteJob ( const Collection &  collection,
QObject *  parent = 0 
) [explicit]

Creates a new collection delete job.

The collection needs to either have a unique identifier or a remote identifier set. Note that using a remote identifier only works in a resource context (that is from within ResourceBase), as remote identifiers are not guaranteed to be globally unique.

Parameters:
collectionThe collection to delete.
parentThe parent object.

Definition at line 41 of file collectiondeletejob.cpp.

CollectionDeleteJob::~CollectionDeleteJob ( )

Destroys the collection delete job.

Definition at line 49 of file collectiondeletejob.cpp.


Member Function Documentation

void CollectionDeleteJob::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 collectiondeletejob.cpp.


The documentation for this class was generated from the following files:
  • collectiondeletejob.h
  • collectiondeletejob.cpp

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal