Development/AkonadiPorting/AddressBook

Introduction

The address book API KABC has been available for application developers for several major version releases of KDE.

Its main entry point for applications is the KABC::StdAddressBook singleton.

The most prevelant usage is loading all address book contents synchronously and the working with the loaded data set, e.g. by calling "find" methods or even iterating over the whole contact pool.

Aside from often needlessly loading the all contacts into memory in every application accessing the address book, the synchronous I/O either meant blocking the application or introducing unexpected re-entrancy when the address book plugins were using nested event loops to process jobs without returning from the called function.

Warning

Akonadi's job based API is capable of doing synchronous execution as well, so one might be tempted to use this instead of the signal/slot approach shown on this page. The recommendation is to only use this as an intermediate step at best, the potential re-entrancy due to the nested event loop can lead to hard to debug problems.

Common Usage Patterns

Most usage patterns involve one of the KABC::AddressBook's "find" methods. Their functionality is now mostly available through Akonadi::ContactSearchJob

Find By Uid

A common use case is to look for a contact object by its identifier, e.g. acquired by user selection somewhen in the past. The code to do that usually looks like this: KABC::AddressBook *addressBook = KABC::StdAddressBook::self();

KABC::Addressee contact = addressBook->findByUid( uidString );

The equivalent using Akonadi API looks like this Akonadi::ContactSearchJob *job = new Akonadi::ContactSearchJob( this ); job->setQuery( Akonadi::ContactSearchJob::ContactUid, uidString );

connect( job, SIGNAL( result( KJob* ) ), SLOT( contactSearchResult( KJob* ) ) ); and void contactSearchResult( KJob *job ) {

 if ( job->error() != 0 ) {
   // error handling, see job->errorString()
   return;
 }

 Akonadi::ContactSearchJob *searchJob = qobject_cast<Akonadi::ContactSearchJob*>( job );

 const KABC::Addressee::List contacts = searchJob->contacts();

}

Tip

Sometimes it is necessary to transport some context from the method which creates the job to the result slot. A convenient way to do this is using the job's setProperty() method.

Find By Email

Another common use case is searching for matching contacts by email address. The code for that with KABC classes is almost identical: KABC::AddressBook *addressBook = KABC::StdAddressBook::self();

KABC::Addressee contact = addressBook->findByEmail( emailString );

Unsurprisingly, the Akonadi code looks also quite similar to the previous use case: Akonadi::ContactSearchJob *job = new Akonadi::ContactSearchJob( this ); job->setQuery( Akonadi::ContactSearchJob::Email, emailString );

connect( job, SIGNAL( result( KJob* ) ), SLOT( contactSearchResult( KJob* ) ) );

The code for the result slot is the same as above.

Development/AkonadiPorting/AddressBook