Akonadi::Server::ItemCopyHandler

Search for usage in LXR

Akonadi::Server::ItemCopyHandler Class Reference

#include <itemcopyhandler.h>

Inheritance diagram for Akonadi::Server::ItemCopyHandler:

Public Member Functions

 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, const QList< Scope::SelectionScope > &permittedScopes) const
 
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 ()
 
template<typename T >
void sendResponse (T &&response)
 
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
 

Protected Member Functions

bool copyItem (const PimItem &item, const Collection &target)
 
void processItems (const QList< qint64 > &ids)
 
- Protected Member Functions inherited from Akonadi::Server::Handler
 Handler (AkonadiServer &akonadi)
 

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 Attributes inherited from Akonadi::Server::Handler
Protocol::CommandPtr m_command
 

Detailed Description

Handler for the COPY command.

This command is used to copy a set of items into the specific collection. It is syntactically identical to the IMAP COPY command.

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)

There is only the usual status response indicating success or failure of the COPY command

Definition at line 32 of file itemcopyhandler.h.

Constructor & Destructor Documentation

◆ ItemCopyHandler()

ItemCopyHandler::ItemCopyHandler ( AkonadiServer & akonadi)

Definition at line 23 of file itemcopyhandler.cpp.

Member Function Documentation

◆ copyItem()

bool ItemCopyHandler::copyItem ( const PimItem & item,
const Collection & target )
protected

Copy the given item and all its parts into the target.

The changes mentioned above are applied.

Definition at line 28 of file itemcopyhandler.cpp.

◆ parseStream()

bool ItemCopyHandler::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 80 of file itemcopyhandler.cpp.

◆ processItems()

void ItemCopyHandler::processItems ( const QList< qint64 > & ids)
protected

Definition at line 53 of file itemcopyhandler.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 11 2024 12:11:40 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.