• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepimlibs API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • TagCreateJob
Public Member Functions | Protected Member Functions | List of all members
Akonadi::TagCreateJob Class Reference

#include <tagcreatejob.h>

Inheritance diagram for Akonadi::TagCreateJob:
Inheritance graph
[legend]

Public Member Functions

 TagCreateJob (const Tag &tag, QObject *parent=0)
 
void setMergeIfExisting (bool merge)
 
Tag tag () const
 
- Public Member Functions inherited from Akonadi::Job
 Job (QObject *parent=0)
 
virtual ~Job ()
 
virtual QString errorString () const
 
void start ()
 

Protected Member Functions

virtual void doHandleResponse (const QByteArray &tag, const QByteArray &data)
 
virtual void doStart ()
 
- Protected Member Functions inherited from Akonadi::Job
virtual bool addSubjob (KJob *job)
 
virtual bool doKill ()
 
void emitWriteFinished ()
 
virtual bool removeSubjob (KJob *job)
 

Additional Inherited Members

- Public Types inherited from Akonadi::Job
enum  Error {
  ConnectionFailed = UserDefinedError, ProtocolVersionMismatch, UserCanceled, Unknown,
  UserError = UserDefinedError + 42
}
 
typedef QList< Job * > List
 
- Signals inherited from Akonadi::Job
void aboutToStart (Akonadi::Job *job)
 
void writeFinished (Akonadi::Job *job)
 
- Protected Slots inherited from Akonadi::Job
virtual void slotResult (KJob *job)
 

Detailed Description

Job that creates a new tag in the Akonadi storage.

Since
4.13

Definition at line 34 of file tagcreatejob.h.

Constructor & Destructor Documentation

TagCreateJob::TagCreateJob ( const Tag &  tag,
QObject *  parent = 0 
)
explicit

Creates a new tag create job.

Parameters
tagThe tag to create.
parentThe parent object.

Definition at line 41 of file tagcreatejob.cpp.

Member Function Documentation

void TagCreateJob::doHandleResponse ( const QByteArray &  tag,
const QByteArray &  data 
)
protectedvirtual

This method should be reimplemented in the concrete jobs in case you want to handle incoming data.

It will be called on received data from the backend. The default implementation does nothing.

Parameters
tagThe tag of the corresponding command, empty if this is an untagged response.
dataThe received data.

Reimplemented from Akonadi::Job.

Definition at line 99 of file tagcreatejob.cpp.

void TagCreateJob::doStart ( )
protectedvirtual

This method must be reimplemented in the concrete jobs.

It will be called after the job has been started and a connection to the Akonadi backend has been established.

Implements Akonadi::Job.

Definition at line 54 of file tagcreatejob.cpp.

void TagCreateJob::setMergeIfExisting ( bool  merge)

Merges the tag by GID if it is already existing, and returns the merged version.

This is false by default.

Note that the returned tag does not contain attributes.

Definition at line 48 of file tagcreatejob.cpp.

Tag TagCreateJob::tag ( ) const

Returns the created tag with the new unique id, or an invalid tag if the job failed.

Definition at line 118 of file tagcreatejob.cpp.


The documentation for this class was generated from the following files:
  • tagcreatejob.h
  • tagcreatejob.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:38:05 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal