akonadi
Akonadi::SpecialCollections Class Reference
An interface to special collections. More...
#include <specialcollections.h>
Inherits QObject.
Signals | |
void | collectionsChanged (const Akonadi::AgentInstance &instance) |
void | defaultCollectionsChanged () |
Public Member Functions | |
~SpecialCollections () | |
Akonadi::Collection | collection (const QByteArray &type, const AgentInstance &instance) const |
Akonadi::Collection | defaultCollection (const QByteArray &type) const |
bool | hasCollection (const QByteArray &type, const AgentInstance &instance) const |
bool | hasDefaultCollection (const QByteArray &type) const |
bool | registerCollection (const QByteArray &type, const Akonadi::Collection &collection) |
Protected Member Functions | |
SpecialCollections (KCoreConfigSkeleton *config, QObject *parent=0) |
Detailed Description
An interface to special collections.
This class is the central interface to special collections like inbox or outbox in a mail resource or recent contacts in a contacts resource. The class is not meant to be used directly, but to inherit the a type specific special collections class from it (e.g. SpecialMailCollections).
To check whether a special collection is available, simply use the hasCollection() and hasDefaultCollection() methods. Available special collections are accessible through the collection() and defaultCollection() methods.
To create a special collection, use a SpecialCollectionsRequestJob. This will create the special collections you request and automatically register them with SpecialCollections, so that it now knows they are available.
This class monitors all special collections known to it, and removes it from the known list if they are deleted. Note that this class does not automatically rebuild the collections that disappeared.
The defaultCollectionsChanged() and collectionsChanged() signals are emitted when the special collections for a resource change (i.e. some became available or some become unavailable).
- Since:
- 4.4
Definition at line 65 of file specialcollections.h.
Constructor & Destructor Documentation
Akonadi::SpecialCollections::~SpecialCollections | ( | ) |
Destroys the special collections object.
Akonadi::SpecialCollections::SpecialCollections | ( | KCoreConfigSkeleton * | config, | |
QObject * | parent = 0 | |||
) | [explicit, protected] |
Creates a new special collections object.
- Parameters:
-
config The configuration skeleton that provides the default resource id. parent The parent object.
Member Function Documentation
Akonadi::Collection Akonadi::SpecialCollections::collection | ( | const QByteArray & | type, | |
const AgentInstance & | instance | |||
) | const |
Returns the special collection of the given type
in the given agent instance
, or an invalid collection if such a collection is unknown.
void Akonadi::SpecialCollections::collectionsChanged | ( | const Akonadi::AgentInstance & | instance | ) | [signal] |
Emitted when the special collections for a resource have been changed (for example, some become available, or some become unavailable).
- Parameters:
-
instance The instance of the resource the collection belongs to.
Akonadi::Collection Akonadi::SpecialCollections::defaultCollection | ( | const QByteArray & | type | ) | const |
Returns the special collection of given type
in the default resource, or an invalid collection if such a collection is unknown.
void Akonadi::SpecialCollections::defaultCollectionsChanged | ( | ) | [signal] |
Emitted when the special collections for the default resource have been changed (for example, some become available, or some become unavailable).
bool Akonadi::SpecialCollections::hasCollection | ( | const QByteArray & | type, | |
const AgentInstance & | instance | |||
) | const |
Returns whether the given agent instance
has a special collection of the given type
.
bool Akonadi::SpecialCollections::hasDefaultCollection | ( | const QByteArray & | type | ) | const |
Returns whether the default resource has a special collection of the given type
.
bool Akonadi::SpecialCollections::registerCollection | ( | const QByteArray & | type, | |
const Akonadi::Collection & | collection | |||
) |
Registers the given collection
as a special collection with the given type
.
The collection must be owned by a valid resource. Registering a new collection of a previously registered type forgets the old collection.
The documentation for this class was generated from the following file: