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

akonadi

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

Job that deletes items from the Akonadi storage. More...

#include <itemdeletejob.h>

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

List of all members.

Public Member Functions

 ItemDeleteJob (const Item &item, QObject *parent=0)
 ItemDeleteJob (const Item::List &items, QObject *parent=0)
 ItemDeleteJob (const Collection &collection, QObject *parent=0)
 ~ItemDeleteJob ()
Item::List deletedItems () const

Protected Member Functions

virtual void doStart ()

Detailed Description

Job that deletes items from the Akonadi storage.

This job removes the given items from the Akonadi storage.

Example:

 const Akonadi::Item item = ...

 ItemDeleteJob *job = new ItemDeleteJob( item );
 connect( job, SIGNAL( result( KJob* ) ), this, SLOT( deletionResult( KJob* ) ) );

Example:

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

 ItemDeleteJob *job = new ItemDeleteJob( items );
 connect( job, SIGNAL( result( KJob* ) ), this, SLOT( deletionResult( KJob* ) ) );
Author:
Volker Krause <vkrause@kde.org>

Definition at line 62 of file itemdeletejob.h.


Constructor & Destructor Documentation

Akonadi::ItemDeleteJob::ItemDeleteJob ( const Item &  item,
QObject *  parent = 0 
) [explicit]

Creates a new item delete job that deletes item.

The item needs to either have a unique identifier or a remote identifier set. In the latter case a collection or resource context needs to be selected (using CollectionSelectJob or ResourceSelectJob).

Parameters:
itemThe item to delete.
parentThe parent object.
Akonadi::ItemDeleteJob::ItemDeleteJob ( const Item::List &  items,
QObject *  parent = 0 
) [explicit]

Creates a new item delete job that deletes all items in the list items.

These items can be located in any collection. The same restrictions on item identifiers apply as in the constructor above.

Parameters:
itemsThe items to delete.
parentThe parent object.
Since:
4.3
Akonadi::ItemDeleteJob::ItemDeleteJob ( const Collection &  collection,
QObject *  parent = 0 
) [explicit]

Creates a new item delete job that deletes all items in the collection collection.

The collection needs to have either a unique identifier or a remote identifier set. In the latter case a resource context needs to be selected using ResourceSelectJob.

Parameters:
collectionThe collection which content should be deleted.
parentThe parent object.
Since:
4.3
ItemDeleteJob::~ItemDeleteJob ( )

Destroys the item delete job.

Definition at line 85 of file itemdeletejob.cpp.


Member Function Documentation

Item::List ItemDeleteJob::deletedItems ( ) const

Returns the items passed on in the constructor.

Since:
4.4

Definition at line 89 of file itemdeletejob.cpp.

virtual void Akonadi::ItemDeleteJob::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.


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

akonadi

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • 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.4
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