Akonadi Namespace Reference

Namespaces
namespace	CollectionUtils
namespace	ContactPart
namespace	MessageFlags
namespace	MessagePart
namespace	PasteHelper
namespace	TrashSettings
namespace	TypePluginLoader

Classes
class	AbstractContactFormatter
	The interface for all contact formatters. More...
class	AbstractContactGroupFormatter
	The interface for all contact group formatters. More...
class	AbstractDifferencesReporter
	An interface to report differences between two arbitrary objects. More...
class	ActionStateManager
	A helper class to manage action states. More...
class	AddressAttribute
	Attribute storing the From, To, Cc, Bcc addresses of a message. More...
class	AgentActionManager
	Manages generic actions for agent and agent instance views. More...
class	AgentBase
	The base class for all Akonadi agents and resources. More...
class	AgentBasePrivate
class	AgentFactory
	A factory for in-process agents. More...
class	AgentFactoryBase
	A factory base class for in-process agents. More...
class	AgentFilterProxyModel
	A proxy model for filtering AgentType or AgentInstance. More...
class	AgentInstance
	A representation of an agent instance. More...
class	AgentInstanceCreateJob
	Job for creating new agent instances. More...
class	AgentInstanceModel
	Provides a data model for agent instances. More...
class	AgentInstanceWidget
	Provides a widget that lists all available agent instances. More...
class	AgentManager
	Provides an interface to retrieve agent types and manage agent instances. More...
class	AgentManagerPrivate
class	AgentSearchInterface
	An interface for agents (or resources) that support searching in their backend. More...
class	AgentType
	A representation of an agent type. More...
class	AgentTypeDialog
	A dialog to select an available agent type. More...
class	AgentTypeModel
	Provides a data model for agent types. More...
class	AgentTypeWidget
	Provides a widget that lists all available agent types. More...
class	AsyncSelectionHandler
class	Attribute
	Provides interface for custom attributes for Entity. More...
class	AttributeFactory
	Provides the functionality of registering and creating arbitrary entity attributes. More...
class	CachePolicy
	Represents the caching policy for a collection. More...
class	CachePolicyPage
	A page in a collection properties dialog to configure the cache policy. More...
class	ChangeNotificationDependenciesFactory
	This class exists so that we can create a fake notification source in unit tests. More...
class	ChangeRecorder
	Records and replays change notification. More...
class	Collection
	Represents a collection of PIM items. More...
class	CollectionAttributesSynchronizationJob
	Job that synchronizes the attributes of a collection. More...
class	CollectionComboBox
	A combobox for selecting an Akonadi collection. More...
class	CollectionCopyJob
	Job that copies a collection into another collection in the Akonadi storage. More...
class	CollectionCreateJob
	Job that creates a new collection in the Akonadi storage. More...
class	CollectionDeleteJob
	Job that deletes a collection in the Akonadi storage. More...
class	CollectionDialog
	A collection selection dialog. More...
class	CollectionFetchJob
	Job that fetches collections from the Akonadi storage. More...
class	CollectionFetchScope
	Specifies which parts of a collection should be fetched from the Akonadi storage. More...
class	CollectionFilterProxyModel
	A proxy model that filters collections by mime type. More...
class	CollectionModel
	A model for collections. More...
class	CollectionModelPrivate
class	CollectionModifyJob
	Job that modifies a collection in the Akonadi storage. More...
class	CollectionMoveJob
	Job that moves a collection in the Akonadi storage to a new parent collection. More...
class	CollectionPathResolver
class	CollectionPrivate
class	CollectionPropertiesDialog
	A generic and extensible dialog for collection properties. More...
class	CollectionPropertiesPage
	A single page in a collection properties dialog. More...
class	CollectionPropertiesPageFactory
	A factory class for collection properties dialog pages. More...
class	CollectionQuotaAttribute
	Attribute that provides quota information for a collection. More...
class	CollectionRequester
	A widget to request an Akonadi collection from the user. More...
class	CollectionRightsAttribute
	Attribute that stores the rights of a collection. More...
class	CollectionSelectJob
class	CollectionStatistics
	Provides statistics information of a Collection. More...
class	CollectionStatisticsDelegate
	A delegate that draws unread and total count for CollectionStatisticsModel. More...
class	CollectionStatisticsJob
	Job that fetches collection statistics from the Akonadi storage. More...
class	CollectionStatisticsModel
	A model that provides statistics for collections. More...
class	CollectionSync
class	CollectionView
	A view to show a collection tree provided by a CollectionModel. More...
class	ConflictHandler
	A class to handle conflicts in Akonadi. More...
class	ConflictResolveDialog
	A dialog to ask the user for a resolve strategy for conflicts. More...
class	ContactDefaultActions
	A convenience class that handles different contact related actions. More...
class	ContactEditor
	An widget to edit contacts in Akonadi. More...
class	ContactEditorDialog
	A dialog for creating or editing a contact in Akonadi. More...
class	ContactEditorPagePlugin
	The base class for custom ContactEditor page plugins. More...
class	ContactGroupEditor
	An widget to edit contact groups in Akonadi. More...
class	ContactGroupEditorDialog
	A dialog for creating or editing a contact group in Akonadi. More...
class	ContactGroupExpandJob
	Job that expands a ContactGroup to a list of contacts. More...
class	ContactGroupSearchJob
	Job that searches for contact groups in the Akonadi storage. More...
class	ContactGroupViewer
	A viewer component for contact groups in Akonadi. More...
class	ContactGroupViewerDialog
	A dialog for displaying a contact group in Akonadi. More...
class	ContactMetaData
	A helper class for storing contact specific settings. More...
class	ContactMetaDataAttribute
	Attribute to store contact specific meta data. More...
class	ContactSearchJob
	Job that searches for contacts in the Akonadi storage. More...
class	ContactsFilterProxyModel
	A proxy model for ContactsTreeModel models. More...
class	ContactsTreeModel
	A model for contacts and contact groups as available in Akonadi. More...
class	ContactViewer
	A viewer component for contacts in Akonadi. More...
class	ContactViewerDialog
	A dialog for displaying a contact in Akonadi. More...
class	Control
	Provides methods to control the Akonadi server process. More...
class	DefaultItemSerializerPlugin
class	DefaultResourceJob
class	DialPhoneNumberAction
	An action to dial the phone number of a contact. More...
class	DifferencesAlgorithmInterface
	An interface to find out differences between two Akonadi objects. More...
class	EmailAddressSelection
	An selection of an email address and corresponding name. More...
class	EmailAddressSelectionDialog
	A dialog to select email addresses from Akonadi. More...
class	EmailAddressSelectionWidget
	A widget to select email addresses from Akonadi. More...
class	Entity
	The base class for Item and Collection. More...
class	EntityCache
class	EntityCacheBase
class	EntityDeletedAttribute
	An Attribute that marks that an entity was marked as deleted. More...
class	EntityDisplayAttribute
	Attribute that stores the properties that are used to display an entity. More...
class	EntityHiddenAttribute
	An Attribute that marks that an entity should be hidden in the UI. More...
class	EntityListView
	A view to show an item/collection list provided by an EntityTreeModel. More...
class	EntityMimeTypeFilterModel
	A proxy model that filters entities by mime type. More...
class	EntityOrderProxyModel
	A model that keeps the order of entities persistent. More...
class	EntityPrivate
class	EntityRightsFilterModel
	A proxy model that filters entities by access rights. More...
class	EntityTreeModel
	A model for collections and items together. More...
class	EntityTreeModelPrivate
class	EntityTreeView
	A view to show an item/collection tree provided by an EntityTreeModel. More...
class	EntityTreeViewStateSaver
	A helper class that saves and restores state of an EntityTreeView. More...
class	ErrorOverlay
class	Exception
	Base class for exceptions used by the Akonadi library. More...
class	FavoriteCollectionsModel
	A model that lists a set of favorite collections. More...
class	Firstrun
	Takes care of setting up default resource agents when running Akonadi for the first time. More...
class	FreeBusyProviderBase
	Base class for resources providing free-busy information. More...
class	FreeBusyProviderBasePrivate
class	GetLockJob
class	IncidenceMimeTypeVisitor
	Helper for getting the Akonadi specific sub MIME type of a KCal::IncidenceBase item, e.g. More...
class	IndexPolicyAttribute
	An attribute to specify how a collection should be indexed for searching. More...
class	InvalidateCacheJob
	Helper job to invalidate item cache for an entire collection. More...
class	Item
	Represents a PIM item stored in Akonadi storage. More...
class	ItemCopyJob
	Job that copies a set of items to a target collection in the Akonadi storage. More...
class	ItemCreateJob
	Job that creates a new item in the Akonadi storage. More...
class	ItemDeleteJob
	Job that deletes items from the Akonadi storage. More...
class	ItemFetchJob
	Job that fetches items from the Akonadi storage. More...
class	ItemFetchScope
	Specifies which parts of an item should be fetched from the Akonadi storage. More...
class	ItemFetchScopePrivate
class	ItemModel
	A table model for items. More...
class	ItemModifyJob
	Job that modifies an existing item in the Akonadi storage. More...
class	ItemModifyJobPrivate
class	ItemMonitor
	A convenience class to monitor a single item for changes. More...
class	ItemMoveJob
	Job that moves an item into a different collection in the Akonadi storage. More...
class	ItemPrivate
class	ItemSearchJob
	Job that searches for items in the Akonadi storage. More...
class	ItemSerializer
class	ItemSerializerPlugin
	The base class for item type serializer plugins. More...
class	ItemSerializerPluginV2
	The extended base class for item type serializer plugins. More...
class	ItemSync
	Syncs between items known to a client (usually a resource) and the Akonadi storage. More...
class	ItemView
	A view to show an item list provided by an ItemModel. More...
class	Job
	Base class for all actions in the Akonadi storage. More...
class	JobPrivate
class	KJobPrivateBase
	Base class for the private class of KJob but not Akonadi::Job based jobs that require the Akonadi server to be operational. More...
class	LinkJob
	Job that links items inside the Akonadi storage. More...
class	LinkJobImpl
	Shared implementation details between item and collection move jobs. More...
class	MessageFolderAttribute
	Message folder information. More...
class	MessageModel
	A flat self-updating message model. More...
class	MessageStatus
	Akonadi KMime Message Status. More...
class	MessageThreaderProxyModel
	Proxy to thread message using the Mailthreader agent. More...
class	MessageThreadingAttribute
	Message threading information. More...
class	MimeTypeChecker
	Helper for checking MIME types of Collections and Items. More...
class	MimeTypeCheckerPrivate
class	Monitor
	Monitors an item or collection for changes. More...
class	MonitorPrivate
class	MoveJobImpl
	Shared implementation details between item and collection move jobs. More...
class	ObjectNotificationMessage
	This class wraps a group of equivalent NotificationMessages from Akonadi. More...
class	PartFetcher
	Convenience class for getting payload parts from an Akonadi Model. More...
class	PersistentSearchAttribute
	An attribute to store query properties of persistent search collections. More...
class	PreprocessorBase
	The base class for all Akonadi preprocessor agents. More...
class	ProtocolHelper
class	RecentContactsCollectionRequestJob
	A job to request the collection used for storing recent contacts. More...
class	RecentContactsCollections
class	RecursiveCollectionFilterProxyModel
	A model to filter out collections of non-matching content types. More...
class	RecursiveItemFetchJob
	Job that fetches all items of a collection recursive. More...
class	RecursiveMover
	Helper class for expanding inter-resource collection moves inside ResourceBase. More...
class	ResourceBase
	The base class for all Akonadi resources. More...
class	ResourceScanJob
class	ResourceSelectJob
	Job that selects a resource context for remote identifier based operations. More...
class	ResourceSynchronizationJob
	Job that synchronizes a resource. More...
class	SearchCreateJob
	Job that creates a virtual/search collection in the Akonadi storage. More...
class	SelectionProxyModel
	A proxy model used to reference count selected Akonadi::Collection in a view. More...
class	SelfTestDialog
	A dialog that checks the current status of the Akonadi system. More...
class	ServerManager
	Provides methods to control the Akonadi server process. More...
class	Session
	A communication session with the Akonadi storage. More...
class	SessionPrivate
class	ShowAddressAction
	A contact action to show the address of a contact on a map. More...
class	SpecialCollectionAttribute
	An Attribute that stores the special collection type of a collection. More...
class	SpecialCollections
	An interface to special collections. More...
class	SpecialCollectionsPrivate
class	SpecialCollectionsRequestJob
	A job to request SpecialCollections. More...
class	SpecialMailCollections
	Interface to special mail collections such as inbox, outbox etc. More...
class	SpecialMailCollectionsRequestJob
	A job to request SpecialMailCollections. More...
class	SpecialMailCollectionsTesting
class	StandardActionManager
	Manages generic actions for collection and item views. More...
class	StandardCalendarActionManager
	Manages calendar specific actions for collection and item views. More...
class	StandardContactActionManager
	Manages contact specific actions for collection and item views. More...
class	StandardContactFormatter
	A class that formats a contact as HTML code. More...
class	StandardContactGroupFormatter
	A class that formats a contact group as HTML code. More...
class	StandardMailActionManager
	Manages emails specific actions for collection and item views. More...
class	StatisticsProxyModel
	A proxy model that exposes collection statistics through extra columns. More...
class	StdStringItemSerializerPlugin
class	SubscriptionDialog
class	SubscriptionJob
	Job to manipulate the local subscription state of a set of collections. More...
class	SubscriptionModel
class	TextBrowser
	A convenience class to remove the 'Copy Link Location' action from the context menu of KTextBrowser. More...
class	TransactionBeginJob
	Job that begins a session-global transaction. More...
class	TransactionCommitJob
	Job that commits a session-global transaction. More...
class	TransactionRollbackJob
	Job that aborts a session-global transaction. More...
class	TransactionSequence
	Base class for jobs that need to run a sequence of sub-jobs in a transaction. More...
class	TransportResourceBase
	Resource implementing mail transport capability. More...
class	TransportResourceBasePrivate
class	TrashFilterProxyModel
	Filter model which hides/shows entites marked as trash. More...
class	TrashJob
	Job that moves items/collection to trash. More...
class	TrashRestoreJob
	Job that restores entites from trash. More...
class	UnlinkJob
	Job that unlinks items inside the Akonadi storage. More...

Typedefs
typedef EntityCache < Collection, CollectionFetchJob, CollectionFetchScope >	CollectionCache
typedef EntityListCache < Collection, CollectionFetchJob, CollectionFetchScope >	CollectionListCache
typedef EntityCache< Item, ItemFetchJob, ItemFetchScope >	ItemCache
typedef EntityListCache< Item, ItemFetchJob, ItemFetchScope >	ItemListCache
typedef std::vector < _detail::TypedPayload >	PayloadContainer

Enumerations
enum	CountType { UnreadCount, TotalCount }

Functions
	AKONADI_EXCEPTION_MAKE_TRIVIAL_INSTANCE (PayloadException)
static QString	format (const QString &mimeType, const QVector< int > &metaTypeIds)
static bool	operator< (const QString &identifier, const PluginEntry &entry)
static bool	operator< (const MimeTypeEntry &lhs, const MimeTypeEntry &rhs)
static bool	operator< (const MimeTypeEntry &lhs, const QString &rhs)
static bool	operator< (const QString &lhs, const MimeTypeEntry &rhs)
uint	qHash (Akonadi::DelegateAnimator::Animation anim)
bool AKONADI_TESTS_EXPORT	releaseLock ()
void	setCollectionAttributes (Akonadi::Collection &col, const QByteArray &type, const QMap< QByteArray, QString > &nameForType, const QMap< QByteArray, QString > &iconForType)

Detailed Description

NOTE: This method is for use in libakonadi-kde and targets under kdepimlibs/akonadi.

A class to manage recent selected folder.

In kdelibs 4.6 there will be a slightly more generic variant available. We need this method as long as we depend on kdelibs 4.5 which doesn't have this method.

Author

Montel Laurent monte.nosp@m.l@kd.nosp@m.e.org

Since

4.8

Function Documentation

bool Akonadi::releaseLock

(

)

Releases the SpecialCollectionsRequestJob lock that was obtained through GetLockJob.

Returns

Whether the lock was released successfully.

Definition at line 648 of file specialcollectionshelperjobs.cpp.

void Akonadi::setCollectionAttributes	(	Akonadi::Collection &	col,
		const QByteArray &	type,
		const QMap< QByteArray, QString > &	nameForType,
		const QMap< QByteArray, QString > &	iconForType
	)

Sets on col the required attributes of SpecialCollection type type.

These are a SpecialCollectionAttribute and an EntityDisplayAttribute.

Definition at line 630 of file specialcollectionshelperjobs.cpp.