Interface implemented by plugins for handling invitations.
More...
#include <invitationhandlerif.h>
|
virtual bool | sendInvitation (const QString &accountId, const QString ¬ebookUid, const KCalendarCore::Incidence::Ptr &invitation, const QString &body)=0 |
| Send a new Invitation to all the participants.
|
|
virtual bool | sendUpdate (const QString &accountId, const KCalendarCore::Incidence::Ptr &invitation, const QString &body)=0 |
| Send a updated invitation to all the participants.
|
|
virtual bool | sendResponse (const QString &accountId, const KCalendarCore::Incidence::Ptr &invitation, const QString &body)=0 |
| Send the updated invitation back to the Organiser.
|
|
virtual QString | pluginName () const =0 |
| The name of this plugin.
|
|
virtual | ~InvitationHandlerInterface () |
|
Interface implemented by plugins for handling invitations.
The invitation is an icidence belonging to a Calendar which in turn contains an account field, that is a unique accountId to identify the account from the Accounts Subsystem. The Calendar also contains a plugin name. The named plugin, implementing this interface, will take care of the actual sending, using the account identified by the accountId. The user of this interface should take care of updating the invitation. The plugins should not modify the invitation object. The invitation is not const only for thecnical reasons.
◆ ~InvitationHandlerInterface()
virtual InvitationHandlerInterface::~InvitationHandlerInterface |
( |
| ) |
|
|
inlinevirtual |
◆ pluginName()
virtual QString InvitationHandlerInterface::pluginName |
( |
| ) |
const |
|
pure virtual |
The name of this plugin.
It should be a uniq name specifying which plugin to use for sending invitations. The plugin name is stored in the Calendars table.
- Returns
- The name of the plugin.
◆ sendInvitation()
virtual bool InvitationHandlerInterface::sendInvitation |
( |
const QString & | accountId, |
|
|
const QString & | notebookUid, |
|
|
const KCalendarCore::Incidence::Ptr & | invitation, |
|
|
const QString & | body ) |
|
pure virtual |
Send a new Invitation to all the participants.
- Parameters
-
accountId | The unique id of the account |
notebookUid | notebook uid of incidence |
invitation | Pointer to the incidence that we want to send |
body | The body of the reply, if any |
- Returns
- True if OK, false otherwise.
◆ sendResponse()
virtual bool InvitationHandlerInterface::sendResponse |
( |
const QString & | accountId, |
|
|
const KCalendarCore::Incidence::Ptr & | invitation, |
|
|
const QString & | body ) |
|
pure virtual |
Send the updated invitation back to the Organiser.
The attendance values should have been updated earlier by the caller.
- Parameters
-
accountId | The unique id of the account |
invitation | Pointer to the incidence that we want to send |
body | The body of the reply, if any |
- Returns
- True if OK, false otherwise.
◆ sendUpdate()
virtual bool InvitationHandlerInterface::sendUpdate |
( |
const QString & | accountId, |
|
|
const KCalendarCore::Incidence::Ptr & | invitation, |
|
|
const QString & | body ) |
|
pure virtual |
Send a updated invitation to all the participants.
This is used for updating invitations we sent earlier.
- Parameters
-
accountId | The unique id of the account |
invitation | Pointer to the incidence that we want to send |
body | The body of the reply, if any |
- Returns
- True if OK, false otherwise.
The documentation for this class was generated from the following file: