Jump to content

KDE PIM/Akonadi Next/Client API

From KDE Community Wiki

The client API consists of:

  • A modification API for messages (Create/Modify/Delete)
  • A query API to retrieve messages
  • A resource facade to abstract the resource implementation details
  • A set of standardized domain types

Domain Types

A set of standardized domain types is defined. This is necessary to decouple applications from resources (so a calendar can access events from all resources). The purpose of these domain types are strictly the interface and they are not supposed to be used by applications directly, or to be restricted by any other specifications (such as ical). By nature these types will be part of the evolving interface, and will need to be adjusted for every new property that an application must understand.

Store Facade

The store is always accessed through a store-type specific facade, which hides:

  • store access (one store could use a database, and another one plain files)
  • message type (flatbuffers, ...)
  • indexes