Akonadi::ResourceSelectJob Class Reference

#include <resourceselectjob_p.h>

Inheritance diagram for Akonadi::ResourceSelectJob:

Public Member Functions
	ResourceSelectJob (const QString &identifier, QObject *parent=0)
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=0)
virtual	~Job ()
virtual QString	errorString () const
void	start ()

Protected Member Functions
void	doStart ()
Protected Member Functions inherited from Akonadi::Job
virtual bool	addSubjob (KJob *job)
virtual void	doHandleResponse (const QByteArray &tag, const QByteArray &data)
virtual bool	doKill ()
void	emitWriteFinished ()
virtual bool	removeSubjob (KJob *job)

Additional Inherited Members
Public Types inherited from Akonadi::Job
enum	Error {   ConnectionFailed = UserDefinedError, ProtocolVersionMismatch, UserCanceled, Unknown,   UserError = UserDefinedError + 42 }
typedef QList< Job * >	List
Signals inherited from Akonadi::Job
void	aboutToStart (Akonadi::Job *job)
void	writeFinished (Akonadi::Job *job)
Protected Slots inherited from Akonadi::Job
virtual void	slotResult (KJob *job)

Detailed Description

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

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 vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

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 41 of file resourceselectjob.cpp.

Member Function Documentation

void ResourceSelectJob::doStart ( )

protectedvirtual

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 48 of file resourceselectjob.cpp.

---

The documentation for this class was generated from the following files:

• resourceselectjob_p.h
• resourceselectjob.cpp