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

akonadi

  • Akonadi
  • ITIPHandler
Public Types | Signals | Public Member Functions | List of all members
Akonadi::ITIPHandler Class Reference

#include <itiphandler.h>

Inherits QObject.

Public Types

enum  Result { ResultError, ResultSuccess }
 

Signals

void informationPublished (Akonadi::ITIPHandler::Result, const QString &errorMessage)
 
void iTipMessageProcessed (Akonadi::ITIPHandler::Result result, const QString &errorMessage)
 
void iTipMessageSent (Akonadi::ITIPHandler::Result, const QString &errorMessage)
 
void sentAsICalendar (Akonadi::ITIPHandler::Result, const QString &errorMessage)
 

Public Member Functions

 ITIPHandler (QObject *parent=0)
 
 ~ITIPHandler ()
 
Akonadi::CalendarBase::Ptr calendar () const
 
void processiTIPMessage (const QString &receiver, const QString &iCal, const QString &type)
 
void publishInformation (const KCalCore::Incidence::Ptr &incidence, QWidget *parentWidget=0)
 
void sendAsICalendar (const KCalCore::Incidence::Ptr &incidence, QWidget *parentWidget=0)
 
void sendiTIPMessage (KCalCore::iTIPMethod method, const KCalCore::Incidence::Ptr &incidence, QWidget *parentWidget=0)
 
void setCalendar (const Akonadi::CalendarBase::Ptr &)
 
void setGroupwareUiDelegate (GroupwareUiDelegate *)
 

Detailed Description

Handles sending of iTip messages aswell as processing incoming ones.

Since
4.11

Definition at line 59 of file itiphandler.h.

Member Enumeration Documentation

enum Akonadi::ITIPHandler::Result
Enumerator
ResultError 

An unexpected error occurred.

ResultSuccess 

The invitation was successfuly handled.

Definition at line 63 of file itiphandler.h.

Constructor & Destructor Documentation

ITIPHandler::ITIPHandler ( QObject *  parent = 0)
explicit

Creates a new ITIPHandler instance.

Definition at line 64 of file itiphandler.cpp.

ITIPHandler::~ITIPHandler ( )

Destroys this instance.

Definition at line 70 of file itiphandler.cpp.

Member Function Documentation

Akonadi::CalendarBase::Ptr ITIPHandler::calendar ( ) const

Returns the calendar used by this itip handler.

Definition at line 369 of file itiphandler.cpp.

void Akonadi::ITIPHandler::informationPublished ( Akonadi::ITIPHandler::Result  ,
const QString &  errorMessage 
)
signal

Signal emitted after an incidence was published with publishInformation()

void Akonadi::ITIPHandler::iTipMessageProcessed ( Akonadi::ITIPHandler::Result  result,
const QString &  errorMessage 
)
signal

Sent after processing an incoming iTip message.

Parameters
resultsuccess of the operation.
errorMessagetranslated error message suitable for user dialogs. Empty if the operation was successul
void Akonadi::ITIPHandler::iTipMessageSent ( Akonadi::ITIPHandler::Result  ,
const QString &  errorMessage 
)
signal

Signal emitted after an iTip message was sent through sendiTIPMessage()

void ITIPHandler::processiTIPMessage ( const QString &  receiver,
const QString &  iCal,
const QString &  type 
)

Processes a received iTip message.

Parameters
receiver
iCal
type
See Also
iTipMessageProcessed()

Definition at line 75 of file itiphandler.cpp.

void ITIPHandler::publishInformation ( const KCalCore::Incidence::Ptr &  incidence,
QWidget *  parentWidget = 0 
)

Publishes incidence incidence.

A publish dialog will prompt the user to input recipients.

See Also
rfc2446 3.2.1

Definition at line 277 of file itiphandler.cpp.

void ITIPHandler::sendAsICalendar ( const KCalCore::Incidence::Ptr &  incidence,
QWidget *  parentWidget = 0 
)

Sends an e-mail with the incidence attached as iCalendar source.

A dialog will prompt the user to input recipients.

Definition at line 313 of file itiphandler.cpp.

void ITIPHandler::sendiTIPMessage ( KCalCore::iTIPMethod  method,
const KCalCore::Incidence::Ptr &  incidence,
QWidget *  parentWidget = 0 
)

Sends an iTip message.

Parameters
methodiTip method
incidenceIncidence for which we're sending the iTip message. Should contain a list of attendees.
parentWidget

Definition at line 233 of file itiphandler.cpp.

void Akonadi::ITIPHandler::sentAsICalendar ( Akonadi::ITIPHandler::Result  ,
const QString &  errorMessage 
)
signal

Signal emitted after an incidence was sent with sendAsICalendar()

void ITIPHandler::setCalendar ( const Akonadi::CalendarBase::Ptr &  calendar)

Sets the calendar that the itip handler should use.

The calendar should already be loaded.

If none is set, a FetchJobCalendar will be created internally.

Definition at line 362 of file itiphandler.cpp.

void ITIPHandler::setGroupwareUiDelegate ( GroupwareUiDelegate *  delegate)

Sets the UI delegate to edit counter proposals.

Definition at line 357 of file itiphandler.cpp.


The documentation for this class was generated from the following files:
  • itiphandler.h
  • itiphandler.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:03:23 by doxygen 1.8.5 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-4.11.3 API Reference

Skip menu "kdepimlibs-4.11.3 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
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