Akonadi::Server::HandlerHelper
#include <handlerhelper.h>
Static Public Member Functions | |
static QList< Protocol::Ancestor > | ancestorsResponse (int ancestorDepth, const QStack< Collection > &ancestors, const QStack< CollectionAttribute::List > &_ancestorsAttributes=QStack< CollectionAttribute::List >()) |
static Protocol::CachePolicy | cachePolicyResponse (const Collection &col) |
static Collection | collectionFromIdOrName (const QByteArray &id) |
static Collection | collectionFromScope (const Scope &scope, const CommandContext &context) |
static Protocol::FetchCollectionsResponse | fetchCollectionsResponse (AkonadiServer &akonadi, const Collection &col) |
static Protocol::FetchCollectionsResponse | fetchCollectionsResponse (AkonadiServer &akonadi, const Collection &col, const CollectionAttribute::List &attributeList, bool includeStatistics=false, int ancestorDepth=0, const QStack< Collection > &ancestors=QStack< Collection >(), const QStack< CollectionAttribute::List > &ancestorAttributes=QStack< CollectionAttribute::List >(), const QStringList &mimeTypes=QStringList()) |
static Protocol::FetchTagsResponse | fetchTagsResponse (const Tag &tag, const Protocol::TagFetchScope &tagFetchScope, Connection *connection=nullptr) |
static QString | pathForCollection (const Collection &col) |
static Flag::List | resolveFlags (const QSet< QByteArray > &flagNames) |
static Tag::List | resolveTagsByGID (const QStringList &tagsGIDs) |
static Tag::List | resolveTagsByRID (const QStringList &tagsRIDs, const CommandContext &context) |
static Tag::List | resolveTagsByUID (const QList< qint64 > &tags) |
static Tag::List | tagsFromScope (const Scope &scope, const CommandContext &context) |
Detailed Description
Helper functions for command handlers.
Definition at line 38 of file handlerhelper.h.
Member Function Documentation
◆ ancestorsResponse()
|
static |
Returns the protocol representation of a collection ancestor chain.
Definition at line 158 of file handlerhelper.cpp.
◆ cachePolicyResponse()
|
static |
Returns the protocol representation of the cache policy of the given Collection object.
Definition at line 69 of file handlerhelper.cpp.
◆ collectionFromIdOrName()
|
static |
Returns the collection identified by the given id or path.
Definition at line 23 of file handlerhelper.cpp.
◆ collectionFromScope()
|
static |
Definition at line 375 of file handlerhelper.cpp.
◆ fetchCollectionsResponse() [1/2]
|
static |
Returns the protocol representation of the given collection.
Make sure DataStore::activeCachePolicy() has been called before to include the effective cache policy
Definition at line 82 of file handlerhelper.cpp.
◆ fetchCollectionsResponse() [2/2]
|
static |
Returns the protocol representation of the given collection.
Make sure DataStore::activeCachePolicy() has been called before to include the effective cache policy
Definition at line 94 of file handlerhelper.cpp.
◆ fetchTagsResponse()
|
static |
Definition at line 192 of file handlerhelper.cpp.
◆ pathForCollection()
|
static |
Returns the full path for the given collection.
Definition at line 58 of file handlerhelper.cpp.
◆ resolveFlags()
|
static |
Converts a bytearray list of flag names into flag records.
- Exceptions
-
HandlerException on errors during database operations
Definition at line 258 of file handlerhelper.cpp.
◆ resolveTagsByGID()
|
static |
Definition at line 289 of file handlerhelper.cpp.
◆ resolveTagsByRID()
|
static |
Definition at line 324 of file handlerhelper.cpp.
◆ resolveTagsByUID()
Converts a imap set of tags into tag records.
- Exceptions
-
HandlerException on errors during database operations
Definition at line 272 of file handlerhelper.cpp.
◆ tagsFromScope()
|
static |
Definition at line 397 of file handlerhelper.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:01:43 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.