KCal::Scheduler Class Reference

#include <scheduler.h>

Inheritance diagram for KCal::Scheduler:

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

Static Public Member Functions
static QString	methodName (iTIPMethod method)
static QString	translatedMethodName (iTIPMethod method)

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

Protected Attributes
Calendar *	mCalendar
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 120 of file scheduler.h.

Constructor & Destructor Documentation

Scheduler::Scheduler ( Calendar *  calendar )

explicit

Creates a scheduler for calendar specified as argument.

Definition at line 123 of file scheduler.cpp.

Member Function Documentation

bool Scheduler::acceptRequest ( IncidenceBase *  incidence, ScheduleMessage::Status  status  )

protected

Deprecated:

: Use the other overload instead KDE5: remove me

Definition at line 282 of file scheduler.cpp.

bool Scheduler::acceptTransaction	(	IncidenceBase *	incidence,
		iTIPMethod	method,
		ScheduleMessage::Status	status
	)

Deprecated:

: Use the other acceptTransaction() instead KDE5: Remove me, make email an optional argument in the other overload

Definition at line 146 of file scheduler.cpp.

bool Scheduler::acceptTransaction	(	IncidenceBase *	incidence,
		iTIPMethod	method,
		ScheduleMessage::Status	status,
		const QString &	email
	)

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 153 of file scheduler.cpp.

FreeBusyCache * Scheduler::freeBusyCache

(

)

const

Returns the free/busy cache.

Definition at line 141 of file scheduler.cpp.

virtual QString KCal::Scheduler::freeBusyDir ( )

pure virtual

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

Implemented in KCal::DummyScheduler.

QString Scheduler::methodName ( iTIPMethod  method )

static

Returns a machine-readable name for a iTIP method.

Definition at line 184 of file scheduler.cpp.

virtual bool KCal::Scheduler::performTransaction ( IncidenceBase *  incidence, 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.

Implemented in KCal::DummyScheduler.

virtual bool KCal::Scheduler::performTransaction ( IncidenceBase *  incidence, 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.

Implemented in KCal::DummyScheduler.

virtual bool KCal::Scheduler::publish ( IncidenceBase *  incidence, const QString &  recipients  )

pure virtual

iTIP publish action

Implemented in KCal::DummyScheduler.

virtual QList<ScheduleMessage*> KCal::Scheduler::retrieveTransactions ( )

pure virtual

Retrieves incoming iTIP transactions.

Implemented in KCal::DummyScheduler.

void Scheduler::setFreeBusyCache

(

FreeBusyCache *

c

)

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

Definition at line 136 of file scheduler.cpp.

QString Scheduler::translatedMethodName ( iTIPMethod  method )

static

Returns a translated human-readable name for a iTIP method.

Definition at line 208 of file scheduler.cpp.

---

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

• scheduler.h
• scheduler.cpp