KCalendarCore::ScheduleMessage Class

class KCalendarCore::ScheduleMessage

A Scheduling message class. More...

Header:	`#include <KCalendarCore/ScheduleMessage>`
CMake:	`find_package(KF6 REQUIRED COMPONENTS CalendarCore)` `target_link_libraries(mytarget PRIVATE KF6::CalendarCore)`

List of all members, including inherited members

Public Types

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

Public Functions

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

Static Public Members

QString methodName(KCalendarCore::iTIPMethod method)

Detailed Description

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

Member Type Documentation

ScheduleMessage::Ptr

A shared pointer to a ScheduleMessage.

enum ScheduleMessage::Status

Message status.

Constant	Value	Description
`KCalendarCore::ScheduleMessage::PublishNew`	`0`	New message posting.
`KCalendarCore::ScheduleMessage::PublishUpdate`	`1`	Updated message.
`KCalendarCore::ScheduleMessage::Obsolete`	`2`	obsolete.
`KCalendarCore::ScheduleMessage::RequestNew`	`3`	Request new message posting.
`KCalendarCore::ScheduleMessage::RequestUpdate`	`4`	Request updated message.
`KCalendarCore::ScheduleMessage::Unknown`	`5`	No status.

Member Function Documentation

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

Creates a scheduling message with method as defined in iTIPMethod and a status. incidence a pointer to a valid Incidence to be associated with this message.

method an iTIPMethod.

status a Status.

`[noexcept]` ScheduleMessage::~ScheduleMessage()

Destructor.

QString ScheduleMessage::error() const

Returns the error message if there is any.

KCalendarCore::IncidenceBase::Ptr ScheduleMessage::event() const

Returns the event associated with this message.

KCalendarCore::iTIPMethod ScheduleMessage::method() const

Returns the iTIP method associated with this message.

`[static]` QString ScheduleMessage::methodName(KCalendarCore::iTIPMethod method)

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