KCalUtils::Scheduler Class Reference

#include <scheduler.h>

Public Member Functions
	Scheduler (const KCalCore::Calendar::Ptr &calendar)
bool	acceptTransaction (const KCalCore::IncidenceBase::Ptr &incidence, KCalCore::iTIPMethod method, KCalCore::ScheduleMessage::Status status, const QString &email=QString())
virtual bool	deleteTransaction (const KCalCore::IncidenceBase::Ptr &incidence)
KCalCore::FreeBusyCache *	freeBusyCache () const
virtual QString	freeBusyDir ()=0
virtual bool	performTransaction (const KCalCore::IncidenceBase::Ptr &incidence, KCalCore::iTIPMethod method)=0
virtual bool	performTransaction (const KCalCore::IncidenceBase::Ptr &incidence, KCalCore::iTIPMethod method, const QString &recipients)=0
virtual bool	publish (const KCalCore::IncidenceBase::Ptr &incidence, const QString &recipients)=0
virtual QList < KCalCore::ScheduleMessage * >	retrieveTransactions ()=0
void	setFreeBusyCache (KCalCore::FreeBusyCache *)

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

Protected Attributes
KCalCore::Calendar::Ptr	mCalendar
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 44 of file scheduler.h.

Constructor & Destructor Documentation

Scheduler::Scheduler ( const KCalCore::Calendar::Ptr &  calendar )

explicit

Creates a scheduler for calendar specified as argument.

Definition at line 46 of file scheduler.cpp.

Member Function Documentation

bool Scheduler::acceptTransaction	(	const KCalCore::IncidenceBase::Ptr &	incidence,
		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.
method	iTIP transaction method to check.
status	scheduling status.
email	the email address of the person for whom this transaction is to be performed.

Definition at line 69 of file scheduler.cpp.

FreeBusyCache * Scheduler::freeBusyCache

(

)

const

Returns the free/busy cache.

Definition at line 64 of file scheduler.cpp.

virtual QString KCalUtils::Scheduler::freeBusyDir ( )

pure virtual

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

virtual bool KCalUtils::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.
method	the iTIP transaction method to use.

virtual bool KCalUtils::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.
method	the iTIP transaction method to use.
recipients	the receipients of the transaction.

virtual bool KCalUtils::Scheduler::publish ( const KCalCore::IncidenceBase::Ptr &  incidence, const QString &  recipients  )

pure virtual

iTIP publish action

virtual QList<KCalCore::ScheduleMessage*> KCalUtils::Scheduler::retrieveTransactions ( )

pure virtual

Retrieves incoming iTIP transactions.

void Scheduler::setFreeBusyCache

(

KCalCore::FreeBusyCache *

c

)

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

Definition at line 59 of file scheduler.cpp.

---

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

• scheduler.h
• scheduler.cpp