Page MenuHomePhorge
Files F117755068

event.h
No OneTemporary
Actions

Authored By
Unknown
Size
3 KB
Referenced Files
None
Subscribers
None

event.h
View Options

/*
* Copyright (C) 2012 Christian Mollekopf <mollekopf@kolabsys.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef EVENT_H
#define EVENT_H
#include <kolabevent.h>
#ifndef SWIG
#include "kolab_export.h"
#include <icalendar/icalendar.h>
#else
/* No export/import SWIG interface files */
#define KOLAB_EXPORT
#endif
namespace Kolab {
namespace Calendaring {
class KOLAB_EXPORT Event: public Kolab::Event
{
public:
Event();
Event(const Kolab::Event &);
~Event();
bool read(const std::string &);
/**
* Convert to kolab xml format.
*/
std::string write() const;
bool fromMime(const std::string &);
/**
* Convert to kolab mime format.
*/
std::string toMime() const;
enum ITipMethod {
iTIPPublish, /**< Event, to-do, journal or freebusy posting */
iTIPRequest, /**< Event, to-do or freebusy scheduling request */
iTIPReply, /**< Event, to-do or freebusy reply to request */
iTIPAdd, /**< Event, to-do or journal additional property request */
iTIPCancel, /**< Event, to-do or journal cancellation notice */
iTIPRefresh, /**< Event or to-do description update request */
iTIPCounter, /**< Event or to-do submit counter proposal */
iTIPDeclineCounter,/**< Event or to-do decline a counter proposal */
iTIPNoMethod /**< No method */
};
bool fromICal(const std::string &);
std::string toICal() const;
bool fromIMip(const std::string &);
std::string toIMip(ITipMethod method) const;
/**
* Returns the scheduling method from the last fromIMip call
*/
ITipMethod getSchedulingMethod() const;
/**
* Updates the delegators and delegatees of the event.
*
* Creates a new attendee for each missing delegatee (delegators are expected to be existing), and then updates each delegatee with the delegator (delegatedFrom).
* Delegators delegatedTo is updated accordingly.
* Existing attendees are tried to be found by uid/email/name (in this order).
*
*/
void delegate(const std::vector<Kolab::Attendee> &delegators, const std::vector<Kolab::Attendee> &delegatees);
/**
* Get attendee by uid/email/name (in this order)
*/
Kolab::Attendee getAttendee(const std::string &);
/**
* Returns the next occurence for a recurring event.
*
* If the start date of the event is passed in, the second occurence is returned (so it can be used in a for loop to loop through all occurences).
*
* If there is no next occurence or the event is not recurring at all an invalid cDateTime is returned.
*/
Kolab::cDateTime getNextOccurence(const Kolab::cDateTime &);
/**
* Returns the corresponding end date-time for a specific occurence.
* @param start is the start date of the occurence.
*/
Kolab::cDateTime getOccurenceEndDate(const Kolab::cDateTime &start);
/**
* Returns the last occurrence, or and invalid cDateTime if the event is not recurring or recurring idenfinitely.
*/
Kolab::cDateTime getLastOccurrence() const;
private:
Kolab::Attendee *getAttendee(const ContactReference &);
Kolab::ITipHandler mITipHandler;
};
};
};
#endif // EVENT_H

File Metadata

Mime Type
text/x-c++
Expires
Sat, Apr 4, 7:39 AM (1 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ae/9a/3af9493ddd4c0a541b0d66ad3e3b
Default Alt Text
event.h (3 KB)

Event Timeline