libkcal Library API Documentation

KCal::ScheduleMessage Class Reference

This class provides an encapsulation of a scheduling message. A Scheduling message. More...

#include <scheduler.h>

List of all members.

Public Types

enum  Status {
  PublishNew, Obsolete, RequestNew, RequestUpdate,
  Unknown
}
 Message status. More...


Public Member Functions

 ScheduleMessage (IncidenceBase *, int method, Status status)
 Create a scheduling message with method as defined in Scheduler::Method and a status.

IncidenceBaseevent ()
 Return event associated with this message.

int method ()
 Return iTIP method associated with this message.

Status status ()
 Return status of this message.

QString error ()
 Return error message if there is any.


Static Public Member Functions

QString statusName (Status status)
 Return a human-readable name for an ical message status.


Detailed Description

This class provides an encapsulation of a scheduling message. A Scheduling message.

It associates an incidence with a method and status information. This class is used by the Scheduler class.

Definition at line 42 of file scheduler.h.


Member Enumeration Documentation

enum KCal::ScheduleMessage::Status
 

Message status.

Definition at line 45 of file scheduler.h.

Referenced by status().


Constructor & Destructor Documentation

ScheduleMessage::ScheduleMessage IncidenceBase ,
int  method,
Status  status
 

Create a scheduling message with method as defined in Scheduler::Method and a status.

Definition at line 39 of file scheduler.cpp.


Member Function Documentation

IncidenceBase* KCal::ScheduleMessage::event  )  [inline]
 

Return event associated with this message.

Definition at line 55 of file scheduler.h.

int KCal::ScheduleMessage::method  )  [inline]
 

Return iTIP method associated with this message.

Definition at line 57 of file scheduler.h.

Status KCal::ScheduleMessage::status  )  [inline]
 

Return status of this message.

Definition at line 59 of file scheduler.h.

References Status.

QString KCal::ScheduleMessage::error  )  [inline]
 

Return error message if there is any.

Definition at line 61 of file scheduler.h.

QString ScheduleMessage::statusName Status  status  )  [static]
 

Return a human-readable name for an ical message status.

Definition at line 46 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