Search for usage in LXR

KCalendarCore::ScheduleMessage Class Reference

#include <schedulemessage.h>

Public Types

typedef QSharedPointer< ScheduleMessagePtr
enum  Status {
  PublishNew , PublishUpdate , Obsolete , RequestNew ,
  RequestUpdate , Unknown

Public Member Functions

 ScheduleMessage (const IncidenceBase::Ptr &incidence, iTIPMethod method, Status status)
 ~ScheduleMessage ()
QString error () const
IncidenceBase::Ptr event () const
iTIPMethod method () const
Status status () const

Static Public Member Functions

static QString methodName (iTIPMethod method)

Detailed Description

A Scheduling message class.

This class provides an encapsulation of a scheduling message. It associates an incidence with an iTIPMethod and status information.

Definition at line 41 of file schedulemessage.h.

Member Typedef Documentation

◆ Ptr

A shared pointer to a ScheduleMessage.

Definition at line 59 of file schedulemessage.h.

Member Enumeration Documentation

◆ Status

Message status.


New message posting.


Updated message.




Request new message posting.


Request updated message.


No status.

Definition at line 47 of file schedulemessage.h.

Constructor & Destructor Documentation

◆ ScheduleMessage()

ScheduleMessage::ScheduleMessage ( const IncidenceBase::Ptr & incidence,
iTIPMethod method,
ScheduleMessage::Status status )

Creates a scheduling message with method as defined in iTIPMethod and a status.

incidencea pointer to a valid Incidence to be associated with this message.
methodan iTIPMethod.
statusa Status.

Definition at line 35 of file schedulemessage.cpp.

◆ ~ScheduleMessage()

ScheduleMessage::~ScheduleMessage ( )


Definition at line 43 of file schedulemessage.cpp.

Member Function Documentation

◆ error()

QString ScheduleMessage::error ( ) const

Returns the error message if there is any.

Definition at line 87 of file schedulemessage.cpp.

◆ event()

IncidenceBase::Ptr ScheduleMessage::event ( ) const

Returns the event associated with this message.

Definition at line 48 of file schedulemessage.cpp.

◆ method()

iTIPMethod ScheduleMessage::method ( ) const

Returns the iTIP method associated with this message.

Definition at line 53 of file schedulemessage.cpp.

◆ methodName()

QString ScheduleMessage::methodName ( iTIPMethod method)

Returns a machine-readable (not translatable) name for a iTIP method.

methodan iTIPMethod.

Definition at line 58 of file schedulemessage.cpp.

◆ status()

ScheduleMessage::Status ScheduleMessage::status ( ) const

Returns the status of this message.

Definition at line 82 of file schedulemessage.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:55:07 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.