Akonadi::ITIPHandler Class Reference

#include <itiphandler.h>

Inherits QObject.

Public Types
enum	Result { ResultError, ResultSuccess, ResultCancelled }

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 *)
void	setShowDialogsOnError (bool enable)

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.
ResultCancelled	User cancelled the operation. Since 4.12

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 62 of file itiphandler.cpp.

ITIPHandler::~ITIPHandler

(

)

Destroys this instance.

Definition at line 68 of file itiphandler.cpp.

Member Function Documentation

Akonadi::CalendarBase::Ptr ITIPHandler::calendar

(

)

const

Returns the calendar used by this itip handler.

Definition at line 378 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

result	success of the operation.
errorMessage	translated 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 73 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 281 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 317 of file itiphandler.cpp.

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

Sends an iTip message.

Parameters

method	iTip method
incidence	Incidence for which we're sending the iTip message. Should contain a list of attendees.
parentWidget

Definition at line 234 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 366 of file itiphandler.cpp.

void ITIPHandler::setGroupwareUiDelegate

(

GroupwareUiDelegate *

delegate

)

Sets the UI delegate to edit counter proposals.

Definition at line 361 of file itiphandler.cpp.

void ITIPHandler::setShowDialogsOnError

(

bool

enable

)

Sets if the ITIP handler should show dialogs on error.

Default is true, for compatibility reasons, but this will change in KDE5. TODO_KDE5: use message delegates

Since

4.12

Definition at line 373 of file itiphandler.cpp.

---

The documentation for this class was generated from the following files:

• itiphandler.h
• itiphandler.cpp