libkcal

KCal::ScheduleMessage Class Reference

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

#include <scheduler.h>

List of all members.


Public Types

enum  Status {
  PublishNew, PublishUpdate, Obsolete, RequestNew,
  RequestUpdate, Unknown
}

Public Member Functions

QString error ()
IncidenceBaseevent ()
int method ()
 ScheduleMessage (IncidenceBase *, int method, Status status)
Status status ()
 ~ScheduleMessage ()

Static Public Member Functions

static QString statusName (Status status)

Detailed Description

This class provides an encapsulation of a scheduling message.

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

A Scheduling message

Definition at line 44 of file scheduler.h.


Member Enumeration Documentation

Message status.

Enumerator:
PublishNew 
PublishUpdate 
Obsolete 
RequestNew 
RequestUpdate 
Unknown 

Definition at line 50 of file scheduler.h.


Constructor & Destructor Documentation

ScheduleMessage::ScheduleMessage ( IncidenceBase incidence,
int  method,
ScheduleMessage::Status  status 
)

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

Definition at line 39 of file scheduler.cpp.

KCal::ScheduleMessage::~ScheduleMessage (  )  [inline]

Definition at line 58 of file scheduler.h.


Member Function Documentation

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

Return error message if there is any.

Definition at line 75 of file scheduler.h.

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

Return event associated with this message.

Definition at line 63 of file scheduler.h.

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

Return iTIP method associated with this message.

Definition at line 67 of file scheduler.h.

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

Return status of this message.

Definition at line 71 of file scheduler.h.

QString ScheduleMessage::statusName ( ScheduleMessage::Status  status  )  [static]

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

Definition at line 46 of file scheduler.cpp.


The documentation for this class was generated from the following files: