Akonadi::Server::CollectionCopyHandler

Akonadi::Server::CollectionCopyHandler Class Reference

#include <collectioncopyhandler.h>

Inheritance diagram for Akonadi::Server::CollectionCopyHandler:

Public Member Functions

 CollectionCopyHandler (AkonadiServer &akonadi)
 
bool parseStream () override
 
- Public Member Functions inherited from Akonadi::Server::ItemCopyHandler
 ItemCopyHandler (AkonadiServer &akonadi)
 
bool parseStream () override
 
- Public Member Functions inherited from Akonadi::Server::Handler
 Handler (const Handler &)=delete
 
 Handler (Handler &&) noexcept=delete
 
AkonadiServer & akonadi () const
 
bool checkScopeConstraints (const Scope &scope, int permittedScopes)
 
Protocol::CommandPtr command () const
 
Connectionconnection () const
 
bool failureResponse (const char *response)
 
bool failureResponse (const QByteArray &response)
 
bool failureResponse (const QString &response)
 
Handleroperator= (const Handler &)=delete
 
Handleroperator= (Handler &&) noexcept=delete
 
template<typename T >
void sendResponse (T &&response)
 
template<typename T >
void sendResponse ()
 
void setCommand (const Protocol::CommandPtr &cmd)
 
void setConnection (Connection *connection)
 
void setTag (quint64 tag)
 
DataStorestorageBackend () const
 
template<typename T >
bool successResponse ()
 
template<typename T >
bool successResponse (T &&response)
 
quint64 tag () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Akonadi::Server::Handler
static std::unique_ptr< HandlerfindHandlerForCommandAlwaysAllowed (Protocol::Command::Type cmd, AkonadiServer &akonadi)
 
static std::unique_ptr< HandlerfindHandlerForCommandAuthenticated (Protocol::Command::Type cmd, AkonadiServer &akonadi)
 
static std::unique_ptr< HandlerfindHandlerForCommandNonAuthenticated (Protocol::Command::Type cmd, AkonadiServer &akonadi)
 
- Protected Member Functions inherited from Akonadi::Server::ItemCopyHandler
bool copyItem (const PimItem &item, const Collection &target)
 
void processItems (const QVector< qint64 > &ids)
 
- Protected Member Functions inherited from Akonadi::Server::Handler
 Handler (AkonadiServer &akonadi)
 
- Protected Attributes inherited from Akonadi::Server::Handler
Protocol::CommandPtr m_command
 

Detailed Description

Handler for the CollectionCopyHandler command.

This command is used to copy a single collection into another collection, including all sub-collections and their content.

The copied items differ in the following points from the originals:

  • new unique id
  • empty remote id
  • possible located in a different collection (and thus resource)

The copied collections differ in the following points from the originals:

  • new unique id
  • empty remote id
  • owning resource is the same as the one of the target collection

Definition at line 36 of file collectioncopyhandler.h.

Member Function Documentation

bool CollectionCopyHandler::parseStream ( )
overridevirtual

Parse and handle the IMAP message using the streaming parser.

The implementation MUST leave the trailing newline character(s) in the stream!

Returns
true if parsed successfully, false in case of parse failure

Implements Akonadi::Server::Handler.

Definition at line 73 of file collectioncopyhandler.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Aug 12 2020 23:16:13 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.