Akonadi::Scheduler Class Reference

#include <scheduler_p.h>

Inherits QObject.

Inherited by Akonadi::MailScheduler.

Public Types
enum	Result {   ResultSuccess, ResultAssigningDifferentTypes, ResultOutatedUpdate, ResultErrorDelete,   ResultIncidenceToDeleteNotFound, ResultGenericError, ResultNoFreeBusyCache, ResultErrorSavingFreeBusy,   ResultCreatingError, ResultModifyingError, ResultDeletingError, ResultUnsupported,   ResultUserCancelled }

Signals
void	transactionFinished (Akonadi::Scheduler::Result, const QString &errorMessage)

Public Member Functions
	Scheduler (QObject *parent=0)
void	acceptTransaction (const KCalCore::IncidenceBase::Ptr &incidence, const Akonadi::CalendarBase::Ptr &calendar, KCalCore::iTIPMethod method, KCalCore::ScheduleMessage::Status status, const QString &email=QString())
KCalCore::FreeBusyCache *	freeBusyCache () const
virtual QString	freeBusyDir () const =0
virtual void	performTransaction (const KCalCore::IncidenceBase::Ptr &incidence, KCalCore::iTIPMethod method)=0
virtual void	performTransaction (const KCalCore::IncidenceBase::Ptr &incidence, KCalCore::iTIPMethod method, const QString &recipients)=0
virtual void	publish (const KCalCore::IncidenceBase::Ptr &incidence, const QString &recipients)=0
void	setFreeBusyCache (KCalCore::FreeBusyCache *)
void	setShowDialogs (bool enable)

Protected Member Functions
void	acceptAdd (const KCalCore::IncidenceBase::Ptr &, KCalCore::ScheduleMessage::Status status)
void	acceptCancel (const KCalCore::IncidenceBase::Ptr &, const Akonadi::CalendarBase::Ptr &calendar, KCalCore::ScheduleMessage::Status status, const QString &attendee)
void	acceptCounter (const KCalCore::IncidenceBase::Ptr &, KCalCore::ScheduleMessage::Status status)
void	acceptDeclineCounter (const KCalCore::IncidenceBase::Ptr &, KCalCore::ScheduleMessage::Status status)
void	acceptFreeBusy (const KCalCore::IncidenceBase::Ptr &, KCalCore::iTIPMethod method)
void	acceptPublish (const KCalCore::IncidenceBase::Ptr &, const Akonadi::CalendarBase::Ptr &calendar, KCalCore::ScheduleMessage::Status status, KCalCore::iTIPMethod method)
void	acceptRefresh (const KCalCore::IncidenceBase::Ptr &, KCalCore::ScheduleMessage::Status status)
void	acceptReply (const KCalCore::IncidenceBase::Ptr &, const Akonadi::CalendarBase::Ptr &calendar, KCalCore::ScheduleMessage::Status status, KCalCore::iTIPMethod method)
void	acceptRequest (const KCalCore::IncidenceBase::Ptr &, const Akonadi::CalendarBase::Ptr &calendar, KCalCore::ScheduleMessage::Status status, const QString &email)

Protected Attributes
KCalCore::ICalFormat *	mFormat

Detailed Description

This class provides an encapsulation of iTIP transactions (RFC 2446).

It is an abstract base class for inheritance by implementations of the iTIP scheme like iMIP or iRIP.

Definition at line 43 of file scheduler_p.h.

Constructor & Destructor Documentation

Akonadi::Scheduler::Scheduler ( QObject *  parent = 0 )

explicit

Creates a scheduler for calendar specified as argument.

Member Function Documentation

void Akonadi::Scheduler::acceptTransaction	(	const KCalCore::IncidenceBase::Ptr &	incidence,
		const Akonadi::CalendarBase::Ptr &	calendar,
		KCalCore::iTIPMethod	method,
		KCalCore::ScheduleMessage::Status	status,
		const QString &	email = QString()
	)

Accepts the transaction.

The incidence argument specifies the iCal component on which the transaction acts. The status is the result of processing a iTIP message with the current calendar and specifies the action to be taken for this incidence.

Parameters

incidence	the incidence for the transaction. Must be valid.
calendar	a loaded calendar.
method	iTIP transaction method to check.
status	scheduling status.
email	the email address of the person for whom this transaction is to be performed.

Listen to the acceptTransactionFinished() signal to know the success.

KCalCore::FreeBusyCache* Akonadi::Scheduler::freeBusyCache

(

)

const

Returns the free/busy cache.

virtual QString Akonadi::Scheduler::freeBusyDir ( ) const

pure virtual

Returns the directory where the free-busy information is stored.

virtual void Akonadi::Scheduler::performTransaction ( const KCalCore::IncidenceBase::Ptr &  incidence, KCalCore::iTIPMethod  method  )

pure virtual

Performs iTIP transaction on incidence.

The method is specified as the method argument and can be any valid iTIP method.

Parameters

incidence	the incidence for the transaction. Must be valid.
method	the iTIP transaction method to use.

virtual void Akonadi::Scheduler::performTransaction ( const KCalCore::IncidenceBase::Ptr &  incidence, KCalCore::iTIPMethod  method, const QString &  recipients  )

pure virtual

Performs iTIP transaction on incidence to specified recipient(s).

The method is specified as the method argumanet and can be any valid iTIP method.

Parameters

incidence	the incidence for the transaction. Must be valid.
method	the iTIP transaction method to use.
recipients	the receipients of the transaction.

virtual void Akonadi::Scheduler::publish ( const KCalCore::IncidenceBase::Ptr &  incidence, const QString &  recipients  )

pure virtual

Notify recipients about incidence.

Parameters

incidence	the incidence to send
recipients	the people to send it to

void Akonadi::Scheduler::setFreeBusyCache

(

KCalCore::FreeBusyCache *

)

Sets the free/busy cache used to store free/busy information.

---

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

• scheduler_p.h