libkcal Library API Documentation

KCal::Scheduler Class Reference

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

#include <scheduler.h>

Inheritance diagram for KCal::Scheduler:

KCal::DummyScheduler List of all members.

Public Types

enum  Method {
  Publish, Request, Refresh, Cancel,
  Add, Reply, Counter, Declinecounter,
  NoMethod
}
 iTIP methods. More...


Public Member Functions

 Scheduler (Calendar *calendar)
 Create scheduler for calendar specified as argument.

virtual bool publish (IncidenceBase *incidence, const QString &recipients)=0
 iTIP publish action

virtual bool performTransaction (IncidenceBase *incidence, Method method)=0
 Perform iTIP transaction on incidence.

virtual bool performTransaction (IncidenceBase *incidence, Method method, const QString &recipients)=0
 Perform iTIP transaction on incidence to specified recipient(s).

virtual QPtrList< ScheduleMessageretrieveTransactions ()=0
 Retrieve incoming iTIP transactions.

bool acceptTransaction (IncidenceBase *, Method method, ScheduleMessage::Status status)
 Accept transaction.

virtual bool deleteTransaction (IncidenceBase *incidence)

Static Public Member Functions

QString methodName (Method)
 Return a human-readable name for a iTIP method.


Protected Member Functions

bool acceptPublish (IncidenceBase *, ScheduleMessage::Status status, Method method)
bool acceptRequest (IncidenceBase *, ScheduleMessage::Status status)
bool acceptAdd (IncidenceBase *, ScheduleMessage::Status status)
bool acceptCancel (IncidenceBase *, ScheduleMessage::Status status)
bool acceptDeclineCounter (IncidenceBase *, ScheduleMessage::Status status)
bool acceptReply (IncidenceBase *, ScheduleMessage::Status status, Method method)
bool acceptRefresh (IncidenceBase *, ScheduleMessage::Status status)
bool acceptCounter (IncidenceBase *, ScheduleMessage::Status status)
bool acceptFreeBusy (IncidenceBase *, Method method)

Protected Attributes

CalendarmCalendar
ICalFormatmFormat

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.

Definition at line 78 of file scheduler.h.


Member Enumeration Documentation

enum KCal::Scheduler::Method
 

iTIP methods.

Definition at line 81 of file scheduler.h.


Constructor & Destructor Documentation

Scheduler::Scheduler Calendar calendar  ) 
 

Create scheduler for calendar specified as argument.

Definition at line 62 of file scheduler.cpp.


Member Function Documentation

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

iTIP publish action

Implemented in KCal::DummyScheduler.

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

Perform iTIP transaction on incidence.

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

Implemented in KCal::DummyScheduler.

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.

Implemented in KCal::DummyScheduler.

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

Retrieve incoming iTIP transactions.

Implemented in KCal::DummyScheduler.

bool 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.

Definition at line 73 of file scheduler.cpp.

QString Scheduler::methodName Method   )  [static]
 

Return a human-readable name for a iTIP method.

Definition at line 101 of file scheduler.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sun Feb 15 11:40:28 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001