libkcal
KCal::Scheduler Class Reference
This class provides an encapsulation of iTIP transactions. More...
#include <scheduler.h>
Inherited by KCal::DummyScheduler, and KCal::IMIPScheduler.
Public Types | |
enum | Method { Publish, Request, Refresh, Cancel, Add, Reply, Counter, Declinecounter, NoMethod } |
Public Member Functions | |
Scheduler (Calendar *calendar) | |
virtual bool | publish (IncidenceBase *incidence, const TQString &recipients)=0 |
virtual bool | performTransaction (IncidenceBase *incidence, Method method)=0 |
virtual bool | performTransaction (IncidenceBase *incidence, Method method, const TQString &recipients)=0 |
virtual TQPtrList < ScheduleMessage > | retrieveTransactions ()=0 |
bool | acceptTransaction (IncidenceBase *, Method method, ScheduleMessage::Status status, const TQString &attendee=TQString::null) |
virtual bool | deleteTransaction (IncidenceBase *incidence) |
virtual TQString | freeBusyDir ()=0 |
void | setFreeBusyCache (FreeBusyCache *) |
FreeBusyCache * | freeBusyCache () const |
Static Public Member Functions | |
static TQString | methodName (Method) |
static TQString | translatedMethodName (Method) |
Protected Member Functions | |
bool | acceptPublish (IncidenceBase *, ScheduleMessage::Status status, Method method) |
bool | acceptRequest (IncidenceBase *, ScheduleMessage::Status status, const TQString &attendee) |
bool | acceptAdd (IncidenceBase *, ScheduleMessage::Status status) |
KDE_DEPRECATED bool | acceptCancel (IncidenceBase *, ScheduleMessage::Status status) |
bool | acceptCancel (IncidenceBase *, ScheduleMessage::Status status, const TQString &attendee) |
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 | |
Calendar * | mCalendar |
ICalFormat * | mFormat |
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 97 of file scheduler.h.
Member Enumeration Documentation
Constructor & Destructor Documentation
Scheduler::Scheduler | ( | Calendar * | calendar | ) |
Member Function Documentation
virtual bool KCal::Scheduler::publish | ( | IncidenceBase * | incidence, | |
const TQString & | 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 TQString & | 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 TQPtrList<ScheduleMessage> KCal::Scheduler::retrieveTransactions | ( | ) | [pure virtual] |
Retrieve incoming iTIP transactions.
bool Scheduler::acceptTransaction | ( | IncidenceBase * | incidence, | |
Method | method, | |||
ScheduleMessage::Status | status, | |||
const TQString & | attendee = TQString::null | |||
) |
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. The attendee is the email address of the person on who's behalf this transaction is to be performed.
Definition at line 100 of file scheduler.cpp.
TQString Scheduler::methodName | ( | Method | method | ) | [static] |
TQString Scheduler::translatedMethodName | ( | Method | method | ) | [static] |
Return a translated human-readable name for a iTIP method.
Definition at line 156 of file scheduler.cpp.
virtual TQString KCal::Scheduler::freeBusyDir | ( | ) | [pure virtual] |
Returns the directory where the free-busy information is stored.
void Scheduler::setFreeBusyCache | ( | FreeBusyCache * | c | ) |
Set free/busy cache used to store free/busy information.
Definition at line 90 of file scheduler.cpp.
FreeBusyCache * Scheduler::freeBusyCache | ( | ) | const |
The documentation for this class was generated from the following files: