KCalendarCore::ScheduleMessage

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 42 of file schedulemessage.h.

Member Typedef Documentation

A shared pointer to a ScheduleMessage.

Definition at line 60 of file schedulemessage.h.

Member Enumeration Documentation

Message status.

Enumerator
PublishNew 

New message posting.

PublishUpdate 

Updated message.

Obsolete 

obsolete

RequestNew 

Request new message posting.

RequestUpdate 

Request updated message.

Unknown 

No status.

Definition at line 48 of file schedulemessage.h.

Constructor & Destructor Documentation

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

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

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

Definition at line 32 of file schedulemessage.cpp.

ScheduleMessage::~ScheduleMessage ( )

Destructor.

Definition at line 42 of file schedulemessage.cpp.

Member Function Documentation

QString ScheduleMessage::error ( ) const

Returns the error message if there is any.

Definition at line 86 of file schedulemessage.cpp.

IncidenceBase::Ptr ScheduleMessage::event ( ) const

Returns the event associated with this message.

Definition at line 47 of file schedulemessage.cpp.

iTIPMethod ScheduleMessage::method ( ) const

Returns the iTIP method associated with this message.

Definition at line 52 of file schedulemessage.cpp.

QString ScheduleMessage::methodName ( iTIPMethod  method)
static

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

Parameters
methodan iTIPMethod.

Definition at line 57 of file schedulemessage.cpp.

ScheduleMessage::Status ScheduleMessage::status ( ) const

Returns the status of this message.

Definition at line 81 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-2020 The KDE developers.
Generated on Wed Aug 5 2020 22:48:59 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.