Akonadi::ITIPHandler Class

Handles sending of iTip messages as well as processing incoming ones. More...

Header: #include <itiphandler.h>
CMake: find_package(KPim6AkonadiCalendar REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::AkonadiCalendar)
Inherits: QObject

Public Functions

ITIPHandler(QObject *parent = nullptr)
ITIPHandler(Akonadi::ITIPHandlerComponentFactory *factory, QObject *parent)
virtual ~ITIPHandler() override
Akonadi::CalendarBase::Ptr calendar() const
(since 26.12) void processiTIPMessage(const QString &receiver, const KCalendarCore::ScheduleMessage::Ptr &message, const QString &action)
void publishInformation(const KCalendarCore::Incidence::Ptr &incidence, QWidget *parentWidget = nullptr)
void sendAsICalendar(const KCalendarCore::Incidence::Ptr &incidence, QWidget *parentWidget = nullptr)
void sendiTIPMessage(KCalendarCore::iTIPMethod method, const KCalendarCore::Incidence::Ptr &incidence, QWidget *parentWidget = nullptr)
void setCalendar(const Akonadi::CalendarBase::Ptr &calendar)
void setGroupwareUiDelegate(Akonadi::GroupwareUiDelegate *delegate)
void setShowDialogsOnError(bool enable)

Signals

void iTipMessageProcessed(Akonadi::ITIPHandler::Result result, const QString &errorMessage)
void iTipMessageSent(Akonadi::ITIPHandler::Result, const QString &errorMessage)
void informationPublished(Akonadi::ITIPHandler::Result, const QString &errorMessage)
void sentAsICalendar(Akonadi::ITIPHandler::Result, const QString &errorMessage)

Detailed Description

Member Function Documentation

[explicit] ITIPHandler::ITIPHandler(QObject *parent = nullptr)

Creates a new ITIPHandler instance. creates a default ITIPHandlerComponentFactory object.

[explicit] ITIPHandler::ITIPHandler(Akonadi::ITIPHandlerComponentFactory *factory, QObject *parent)

Create a new ITIPHandler instance. factory is set to 0 a new factory is created.

[override virtual noexcept] ITIPHandler::~ITIPHandler()

Destroys this instance.

Akonadi::CalendarBase::Ptr ITIPHandler::calendar() const

Returns the calendar used by this itip handler.

See also setCalendar().

[signal] void ITIPHandler::iTipMessageProcessed(Akonadi::ITIPHandler::Result result, const QString &errorMessage)

Sent after processing an incoming iTip message.

result success of the operation. errorMessage translated error message suitable for user dialogs. Empty if the operation was successful

[signal] void ITIPHandler::iTipMessageSent(Akonadi::ITIPHandler::Result, const QString &errorMessage)

Signal emitted after an iTip message was sent through sendiTIPMessage()

[signal] void ITIPHandler::informationPublished(Akonadi::ITIPHandler::Result, const QString &errorMessage)

Signal emitted after an incidence was published with publishInformation()

[since 26.12] void ITIPHandler::processiTIPMessage(const QString &receiver, const KCalendarCore::ScheduleMessage::Ptr &message, const QString &action)

Processes a received iTip message.

receiver message The parsed schedule message ("invitation") action

This function was introduced in 26.12.

See also iTipMessageProcessed().

void ITIPHandler::publishInformation(const KCalendarCore::Incidence::Ptr &incidence, QWidget *parentWidget = nullptr)

Publishes incidence incidence. A publish dialog will prompt the user to input recipients.

See also rfc2446 and 3.2.1.

void ITIPHandler::sendAsICalendar(const KCalendarCore::Incidence::Ptr &incidence, QWidget *parentWidget = nullptr)

Sends an e-mail with the incidence attached as iCalendar source. A dialog will prompt the user to input recipients.

void ITIPHandler::sendiTIPMessage(KCalendarCore::iTIPMethod method, const KCalendarCore::Incidence::Ptr &incidence, QWidget *parentWidget = nullptr)

Sends an iTip message.

method iTip method incidence Incidence for which we're sending the iTip message. Should contain a list of attendees. parentWidget

[signal] void ITIPHandler::sentAsICalendar(Akonadi::ITIPHandler::Result, const QString &errorMessage)

Signal emitted after an incidence was sent with sendAsICalendar()

void ITIPHandler::setCalendar(const Akonadi::CalendarBase::Ptr &calendar)

Sets the calendar that the itip handler should use. The calendar should already be loaded.

If none is set, a FetchJobCalendar will be created internally.

See also calendar().

void ITIPHandler::setGroupwareUiDelegate(Akonadi::GroupwareUiDelegate *delegate)

Sets the UI delegate to edit counter proposals.

void ITIPHandler::setShowDialogsOnError(bool enable)

Sets if the ITIP handler should show dialogs on error. Default is true, for compatibility reasons, but this will change in KDE5. TODO_KDE5: use message delegates