libkcal Library API Documentation

KCal::Scheduler Class Reference

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

#include <scheduler.h>

List of all members.

Public Types

enum  Method {
  Publish, Request, Refresh, Cancel,
  Add, Reply, Counter, Declinecounter,
  NoMethod
}

Public Methods

 Scheduler (Calendar *calendar)
virtual ~Scheduler ()
virtual bool publish (IncidenceBase *incidence, const QString &recipients)=0
virtual bool performTransaction (IncidenceBase *incidence, Method method)=0
virtual bool performTransaction (IncidenceBase *incidence, Method method, const QString &recipients)=0
virtual QPtrList< ScheduleMessageretrieveTransactions ()=0
bool acceptTransaction (IncidenceBase *, Method method, ScheduleMessage::Status status)
virtual bool deleteTransaction (IncidenceBase *incidence)
virtual QString freeBusyDir ()=0

Static Public Methods

QString methodName (Method)
QString translatedMethodName (Method)

Protected Methods

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 94 of file scheduler.h.


Member Enumeration Documentation

enum KCal::Scheduler::Method
 

iTIP methods.

Definition at line 100 of file scheduler.h.


Constructor & Destructor Documentation

Scheduler::Scheduler Calendar   calendar
 

Create scheduler for calendar specified as argument.

Definition at line 65 of file scheduler.cpp.

References KCal::Calendar::isLocalTime(), KCal::ICalFormat::setTimeZone(), and KCal::Calendar::timeZoneId().


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

References methodName().

QString Scheduler::methodName Method    [static]
 

Return a machine-readable name for a iTIP method.

Definition at line 107 of file scheduler.cpp.

References QString::fromLatin1().

Referenced by acceptTransaction().

QString Scheduler::translatedMethodName Method    [static]
 

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

Definition at line 131 of file scheduler.cpp.

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

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


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkcal Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:36:25 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003