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

akonadi

Akonadi::ResourceScanJob

Akonadi::ResourceScanJob Class Reference

#include <specialcollectionshelperjobs_p.h>

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

List of all members.

Public Member Functions

 ResourceScanJob (const QString &resourceId, KCoreConfigSkeleton *settings, QObject *parent=0)
 ~ResourceScanJob ()
QString resourceId () const
Akonadi::Collection rootResourceCollection () const
void setResourceId (const QString &resourceId)
Akonadi::Collection::List specialCollections () const

Protected Member Functions

virtual void doStart ()

Detailed Description

For internal use only.

Helper job for SpecialCollectionsRequestJob.A Job that fetches all the collections of a resource, and returns only those that have a SpecialCollectionAttribute.

Author:
Constantin Berzan <exit3219@gmail.com>
Since:
4.4

Definition at line 45 of file specialcollectionshelperjobs_p.h.


Constructor & Destructor Documentation

ResourceScanJob::ResourceScanJob ( const QString &  resourceId,
KCoreConfigSkeleton *  settings,
QObject *  parent = 0 
) [explicit]

Creates a new ResourceScanJob.

Definition at line 153 of file specialcollectionshelperjobs.cpp.

ResourceScanJob::~ResourceScanJob (  ) 

Destroys this ResourceScanJob.

Definition at line 160 of file specialcollectionshelperjobs.cpp.


Member Function Documentation

void ResourceScanJob::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.

Reimplemented from Akonadi::TransactionSequence.

Reimplemented in Akonadi::DefaultResourceJob.

Definition at line 185 of file specialcollectionshelperjobs.cpp.

QString ResourceScanJob::resourceId (  )  const

Returns the resource ID of the resource being scanned.

Definition at line 165 of file specialcollectionshelperjobs.cpp.

Collection ResourceScanJob::rootResourceCollection (  )  const

Returns the root collection of the resource being scanned.

This function relies on there being a single top-level collection owned by this resource.

Definition at line 175 of file specialcollectionshelperjobs.cpp.

void ResourceScanJob::setResourceId ( const QString &  resourceId  ) 

Sets the resource ID of the resource to scan.

Definition at line 170 of file specialcollectionshelperjobs.cpp.

Collection::List ResourceScanJob::specialCollections (  )  const

Returns all the collections of this resource which have a SpecialCollectionAttribute.

These might include the root resource collection.

Definition at line 180 of file specialcollectionshelperjobs.cpp.


The documentation for this class was generated from the following files:
  • specialcollectionshelperjobs_p.h
  • specialcollectionshelperjobs.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