KDE 4.2 PyKDE API Reference

- KDE's Python API

# akonadi Module

## Akonadi client library

Introduction

libakonadi is the client access library for using the Akonadi PIM data server. All processes accessing Akonadi, including those which communicate with a remote server (\ref akonadi_design_agents "agents"), are considered clients.

Functionality provided by libakonadi:

- libakonadi_objects - libakonadi_collections - libakonadi_pimitems - libakonadi_jobs - libakonadi_monitor - libakonadi_serializer - libakonadi_resource - libakonadi_integration

Akonadi Objects

Akonadi works on two basic object types: collections and items.

Collections are comparable to folders in a file system and are represented by the class Akonadi.Collection. Every collection has an associated cache policy represented by the class Akonadi.CachePolicy which defines what part of its content is cached for how long. All available ways to work with collections are listed in the libakonadi_collections "Collections" section.

Akonadi items are comparable to files in a file system and are represented by the class Akonadi.Item. Each item represents a single PIM object such as a mail or a contact. The actual object it represents is its so-called payload. All available ways to work with items are listed in the libakonadi_pimitems "Items" section.

Both, items and collections, are identified by a persistent unique identifier. Also, they can contain arbitrary attributes (derived from Akonadi.Attribute) to attach general or application specific meta data to them. Functionality common to both is provided by their base class Akonadi.Entity.

Collection retrieval and manipulation

See akonadi_concepts_collections "Collection Concept" for more information about the concept of collections. A collection is represented by the Akonadi.Collection class.

Classes to retrieve information about collections:

- Akonadi.CollectionFetchJob - Akonadi.CollectionSelectJob - Akonadi.CollectionStatisticsJob

Classes to manipulate collections:

- Akonadi.CollectionCreateJob - Akonadi.CollectionCopyJob - Akonadi.CollectionModifyJob - Akonadi.CollectionDeleteJob

There is also Akonadi.CollectionModel, which is a self-updating model class which can be used in combination with Akonadi.CollectionView. Akonadi.CollectionFilterProxyModel can be used to limit a displayed collection tree to collections supporting a certain type of PIM items. Akonadi.CollectionPropertiesDialog provides an extensible properties dialog for collections. Often needed KAction for collection operations are provided by Akonadi.StandardActionManager.

PIM item retrieval and manipulation

PIM items are represented by classes derived from Akonadi.Item. Items can be retrieved using Akonadi.ItemFetchJob.

The following classes are provided to manipulate PIM items:

- Akonadi.ItemCreateJob - Akonadi.ItemCopyJob - Akonadi.ItemModifyJob - Akonadi.ItemDeleteJob - Akonadi.ExpungeJob

Akonadi.ItemModel provides a self-updating model class which can be used to display the content of a collection. Akonadi.ItemView is the base-class for a corresponding view. Often needed KAction for item operations are provided by Akonadi.StandardActionManager.

Low-level access to the Akonadi server

Accessing the Akonadi server is done using job-classes derived from Akonadi.Job. The communication channel with the server is provided by Akonadi.Session.

To use server-side transactions, the following jobs are provided:

- Akonadi.TransactionBeginJob - Akonadi.TransactionCommitJob - Akonadi.TransactionRollbackJob

There also is Akonadi.TransactionSequence which can be used to automatically group a set of jobs to a single transaction.

Change notifications

The Akonadi.Monitor class allows you to monitor specific resources, collections and PIM items for changes. Akonadi.ChangeRecorder augments this by providing a way to record and replay change notifications.

PIM item serializer

The class Akonadi.ItemSerializer is responsible for converting between the stored (binary) representation of a PIM item and the objects used to handle these items provided by the corresponding libraries (kabc, kcal, etc.).

Serializer plugins allow you to add support for new kinds of PIM items to Akonadi. Akonadi.ItemSerializerPlugin can be used as a base class for such a plugin.

Agents and Resources

The class Akonadi.AgentBase is the common base class for all agents. It provides commonly needed functionality such as change monitoring and recording.

Resources are a special kind of agents. Akonadi.ResourceBase is the base class for them. It provides the necessary interfaces to the server as well as many convenience functions to make implementing a new resource as easy as possible.

Integration in your application

Akonadi.Control provides ways to ensure that the Akonadi server is running, to monitor its availability and provide help on server-side errors. A more low-level interface to the Akonadi server is provided by Akonadi.ServerManager.

A set of standard actions is provided by Akonadi.StandardActionManager. These provided consistent look and feel across applications.

## Namespaces

A | Akonadi.ContactPart | global
Akonadi | G |

## Class Index

A | CollectionPropertiesPage (Akonadi) | J
AgentFilterProxyModel (Akonadi) | CollectionPropertiesPageFactory (Akonadi) | Job (Akonadi)
AgentInstance (Akonadi) | CollectionStatistics (Akonadi) | L
AgentInstanceCreateJob (Akonadi) | CollectionStatisticsDelegate (Akonadi) | LinkJob (Akonadi)
AgentInstanceModel (Akonadi) | CollectionStatisticsJob (Akonadi) | M
AgentInstanceWidget (Akonadi) | CollectionStatisticsModel (Akonadi) | MessageModel (Akonadi)
AgentManager (Akonadi) | CollectionView (Akonadi) | MessageThreaderProxyModel (Akonadi)
AgentType (Akonadi) | Control (Akonadi) | MessageThreadingAttribute (Akonadi)
AgentTypeDialog (Akonadi) | E | Monitor (Akonadi)
AgentTypeModel (Akonadi) | Entity (Akonadi) | R
AgentTypeWidget (Akonadi) | EntityDisplayAttribute (Akonadi) | ResourceBase (Akonadi)
Attribute (Akonadi) | I | ResourceBase (Akonadi)
AttributeFactory (Akonadi) | Item (Akonadi) | S
C | ItemCopyJob (Akonadi) | SearchCreateJob (Akonadi)
CachePolicy (Akonadi) | ItemCreateJob (Akonadi) | ServerManager (Akonadi)
ChangeRecorder (Akonadi) | ItemDeleteJob (Akonadi) | Session (Akonadi)
Collection (Akonadi) | ItemFetchJob (Akonadi) | StandardActionManager (Akonadi)
CollectionCopyJob (Akonadi) | ItemFetchScope (Akonadi) | T
CollectionCreateJob (Akonadi) | ItemModel (Akonadi) | TransactionBeginJob (Akonadi)
CollectionDeleteJob (Akonadi) | ItemModifyJob (Akonadi) | TransactionCommitJob (Akonadi)
CollectionFetchJob (Akonadi) | ItemMonitor (Akonadi) | TransactionRollbackJob (Akonadi)
CollectionFilterProxyModel (Akonadi) | ItemMoveJob (Akonadi) | TransactionSequence (Akonadi)
CollectionModel (Akonadi) | ItemSerializerPlugin (Akonadi) | U
CollectionModifyJob (Akonadi) | ItemSync (Akonadi) | UnlinkJob (Akonadi)
CollectionPropertiesDialog (Akonadi) | ItemView (Akonadi) |