KDE PIM / Developers / API Docs / libkcal

KCal::Scheduler Class Reference

This class provides an encapsulation of iTIP transactions. More...

#include <scheduler.h>

Inherited by KCal::DummyScheduler, and KCal::IMIPScheduler.

List of all members.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes


Detailed Description

This class provides an encapsulation of iTIP transactions.

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


Member Enumeration Documentation

enum KCal::Scheduler::Method
 

iTIP methods.


Constructor & Destructor Documentation

KCal::Scheduler::Scheduler Calendar calendar  ) 
 

Create scheduler for calendar specified as argument.


Member Function Documentation

virtual bool KCal::Scheduler::publish IncidenceBase incidence,
const QString &  recipients
[pure virtual]
 

iTIP publish action

virtual bool KCal::Scheduler::performTransaction IncidenceBase incidence,
Method  method
[pure virtual]
 

Perform iTIP transaction on incidence.

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

virtual bool KCal::Scheduler::performTransaction IncidenceBase incidence,
Method  method,
const QString &  recipients
[pure virtual]
 

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

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

virtual QPtrList<ScheduleMessage> KCal::Scheduler::retrieveTransactions  )  [pure virtual]
 

Retrieve incoming iTIP transactions.

bool KCal::Scheduler::acceptTransaction IncidenceBase ,
Method  method,
ScheduleMessage::Status  status
 

Accept transaction.

The incidence argument specifies the iCal compoennt 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.

static QString KCal::Scheduler::methodName Method   )  [static]
 

Return a machine-readable name for a iTIP method.

static QString KCal::Scheduler::translatedMethodName Method   )  [static]
 

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

virtual QString KCal::Scheduler::freeBusyDir  )  [pure virtual]
 

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

void KCal::Scheduler::setFreeBusyCache FreeBusyCache *   ) 
 

Set free/busy cache used to store free/busy information.

FreeBusyCache* KCal::Scheduler::freeBusyCache  )  const
 

Return free/busy cache.


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