KCalUtils Library
#include <scheduler.h>
Public Member Functions | |
Scheduler (const KCalCore::Calendar::Ptr &calendar) | |
bool | acceptTransaction (const KCalCore::IncidenceBase::Ptr &incidence, KCalCore::iTIPMethod method, KCalCore::ScheduleMessage::Status status, const QString &email=QString()) |
virtual bool | deleteTransaction (const KCalCore::IncidenceBase::Ptr &incidence) |
KCalCore::FreeBusyCache * | freeBusyCache () const |
virtual QString | freeBusyDir ()=0 |
virtual bool | performTransaction (const KCalCore::IncidenceBase::Ptr &incidence, KCalCore::iTIPMethod method)=0 |
virtual bool | performTransaction (const KCalCore::IncidenceBase::Ptr &incidence, KCalCore::iTIPMethod method, const QString &recipients)=0 |
virtual bool | publish (const KCalCore::IncidenceBase::Ptr &incidence, const QString &recipients)=0 |
virtual QList< KCalCore::ScheduleMessage * > | retrieveTransactions ()=0 |
void | setFreeBusyCache (KCalCore::FreeBusyCache *) |
Protected Attributes | |
KCalCore::Calendar::Ptr | mCalendar |
KCalCore::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 44 of file scheduler.h.
Constructor & Destructor Documentation
◆ Scheduler()
|
explicit |
Creates a scheduler for calendar specified as argument.
Definition at line 46 of file scheduler.cpp.
◆ ~Scheduler()
|
virtual |
Definition at line 53 of file scheduler.cpp.
Member Function Documentation
◆ acceptAdd()
|
protected |
Definition at line 265 of file scheduler.cpp.
◆ acceptCancel()
|
protected |
Definition at line 272 of file scheduler.cpp.
◆ acceptCounter()
|
protected |
Definition at line 535 of file scheduler.cpp.
◆ acceptDeclineCounter()
|
protected |
Definition at line 358 of file scheduler.cpp.
◆ acceptFreeBusy()
|
protected |
Definition at line 542 of file scheduler.cpp.
◆ acceptPublish()
|
protected |
Definition at line 103 of file scheduler.cpp.
◆ acceptRefresh()
|
protected |
Definition at line 527 of file scheduler.cpp.
◆ acceptReply()
|
protected |
Definition at line 366 of file scheduler.cpp.
◆ acceptRequest()
|
protected |
Definition at line 148 of file scheduler.cpp.
◆ acceptTransaction()
bool Scheduler::acceptTransaction | ( | const KCalCore::IncidenceBase::Ptr & | incidence, |
KCalCore::iTIPMethod | method, | ||
KCalCore::ScheduleMessage::Status | status, | ||
const QString & | email = QString() ) |
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 69 of file scheduler.cpp.
◆ deleteTransaction()
|
virtual |
Definition at line 98 of file scheduler.cpp.
◆ freeBusyCache()
FreeBusyCache * Scheduler::freeBusyCache | ( | ) | const |
Returns the free/busy cache.
Definition at line 64 of file scheduler.cpp.
◆ freeBusyDir()
|
pure virtual |
Returns the directory where the free-busy information is stored.
◆ performTransaction() [1/2]
|
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.
◆ performTransaction() [2/2]
|
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.
◆ publish()
|
pure virtual |
iTIP publish action
◆ retrieveTransactions()
|
pure virtual |
Retrieves incoming iTIP transactions.
◆ setFreeBusyCache()
void Scheduler::setFreeBusyCache | ( | KCalCore::FreeBusyCache * | c | ) |
Sets the free/busy cache used to store free/busy information.
Definition at line 59 of file scheduler.cpp.
Member Data Documentation
◆ mCalendar
|
protected |
Definition at line 150 of file scheduler.h.
◆ mFormat
|
protected |
Definition at line 151 of file scheduler.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.