• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.8.5 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • ResourceScanJob
Public Member Functions | Protected Member Functions
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

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

Constructor & Destructor Documentation

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

Creates a new ResourceScanJob.

Definition at line 155 of file specialcollectionshelperjobs.cpp.

ResourceScanJob::~ResourceScanJob ( )

Destroys this ResourceScanJob.

Definition at line 162 of file specialcollectionshelperjobs.cpp.


Member Function Documentation

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

Implements Akonadi::Job.

Reimplemented in Akonadi::DefaultResourceJob.

QString ResourceScanJob::resourceId ( ) const

Returns the resource ID of the resource being scanned.

Definition at line 167 of file specialcollectionshelperjobs.cpp.

Akonadi::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 177 of file specialcollectionshelperjobs.cpp.

void ResourceScanJob::setResourceId ( const QString &  resourceId)

Sets the resource ID of the resource to scan.

Definition at line 172 of file specialcollectionshelperjobs.cpp.

Akonadi::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 182 of file specialcollectionshelperjobs.cpp.


The documentation for this class was generated from the following files:
  • specialcollectionshelperjobs_p.h
  • specialcollectionshelperjobs.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon Aug 27 2012 22:09:28 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

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

kdepimlibs-4.8.5 API Reference

Skip menu "kdepimlibs-4.8.5 API Reference"
  • 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
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal