Akonadi::ResourceSelectJob Class Reference

Job that selects a resource context for remote identifier based operations. More...

#include <resourceselectjob_p.h>

Inheritance diagram for Akonadi::ResourceSelectJob:

List of all members.

Public Member Functions

 ResourceSelectJob (const QString &identifier, QObject *parent=0)

Protected Member Functions

void doStart ()

Detailed Description

Job that selects a resource context for remote identifier based operations.

For internal use only.

This job selects a resource context that is used whenever remote identifier based operations ( e.g. fetch items or collections by remote identifier ) are executed.Example:

 using namespace Akonadi;

 // Find out the akonadi id of the item with the remote id 'd1627013c6d5a2e7bb58c12560c27047'
 // that is stored in the resource with identifier 'my_mail_resource'

 Session *m_resourceSession = new Session( "resourceSession" );

 ResourceSelectJob *job = new ResourceSelectJob( "my_mail_resource", resourceSession );

 connect( job, SIGNAL( result( KJob* ) ), SLOT( resourceSelected( KJob* ) ) );
 ...

 void resourceSelected( KJob *job )
 {
   if ( job->error() )
     return;

   Item item;
   item.setRemoteIdentifier( "d1627013c6d5a2e7bb58c12560c27047" );

   ItemFetchJob *fetchJob = new ItemFetchJob( item, m_resourceSession );
   connect( fetchJob, SIGNAL( result( KJob* ) ), SLOT( itemFetched( KJob* ) ) );
 }

 void itemFetched( KJob *job )
 {
   if ( job->error() )
     return;

   const Item item = job->items().first();

   qDebug() << "Remote id" << item.remoteId() << "has akonadi id" << item.id();
 }
Author:
Volker Krause <vkrause@kde.org>

Definition at line 82 of file resourceselectjob_p.h.


Constructor & Destructor Documentation

ResourceSelectJob::ResourceSelectJob ( const QString &  identifier,
QObject *  parent = 0 
) [explicit]

Selects the specified resource for all following remote identifier based operations in the same session.

Parameters:
identifier The resource identifier, or any empty string to reset the selection.
parent The parent object.

Definition at line 40 of file resourceselectjob.cpp.


Member Function Documentation

void ResourceSelectJob::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 47 of file resourceselectjob.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys