• Skip to content
  • Skip to link menu
KDE 4.4 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

Akonadi::SearchCreateJob

Akonadi::SearchCreateJob Class Reference

Job that creates a virtual/search collection in the Akonadi storage. More...

#include <searchcreatejob.h>

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

List of all members.

Public Member Functions

 SearchCreateJob (const QString &name, const QString &query, QObject *parent=0)
 ~SearchCreateJob ()
Collection createdCollection () const

Protected Member Functions

void doHandleResponse (const QByteArray &tag, const QByteArray &data)
void doStart ()

Detailed Description

Job that creates a virtual/search collection in the Akonadi storage.

This job creates so called virtual or search collections, which don't contain real data, but references to items that match a given search query.

 const QString name = "My search folder";
 const QString query = "...";

 Akonadi::SearchCreateJob *job = new Akonadi::SearchCreateJob( name, query );
 connect( job, SIGNAL( result( KJob* ) ), SLOT( jobFinished( KJob* ) ) );

 MyClass::jobFinished( KJob *job )
 {
   if ( job->error() ) {
     qDebug() << "Error occurred";
     return;
   }

   qDebug() << "Created search folder successfully";
   const Collection searchCollection = job->createdCollection();
   ...
 }
Author:
Volker Krause <vkrause@kde.org>

Definition at line 60 of file searchcreatejob.h.


Constructor & Destructor Documentation

SearchCreateJob::SearchCreateJob ( const QString &  name,
const QString &  query,
QObject *  parent = 0 
)

Creates a search create job.

Parameters:
name The name of the search collection.
query The search query (format not defined yet).
parent The parent object.

Definition at line 43 of file searchcreatejob.cpp.

SearchCreateJob::~SearchCreateJob (  ) 

Destroys the search create job.

Definition at line 52 of file searchcreatejob.cpp.


Member Function Documentation

Collection SearchCreateJob::createdCollection (  )  const

Returns the newly created search collection once the job finished successfully.

Returns an invalid collection if the job has not yet finished or failed.

Since:
4.4

Definition at line 68 of file searchcreatejob.cpp.

void SearchCreateJob::doHandleResponse ( const QByteArray &  tag,
const QByteArray &  data 
) [protected, virtual]

Reimplemented from Akonadi::Job.

Reimplemented from Akonadi::Job.

Definition at line 74 of file searchcreatejob.cpp.

void SearchCreateJob::doStart (  )  [protected, virtual]

Reimplemented from Akonadi::Job.

Implements Akonadi::Job.

Definition at line 56 of file searchcreatejob.cpp.


The documentation for this class was generated from the following files:
  • searchcreatejob.h
  • searchcreatejob.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
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.6.2-20100208
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