ICalendarData

Since: BlackBerry 10.0.0

#include <bb/pim/calendar/ICalendarData>

To link against this class, add the following line to your .pro file: LIBS += -lbbpim

The ICalendarData class represents iCalendar file data for a calendar event.

This class includes additional information for a calendar event that's created from an iCalendar attachment, such as method, event sequence, and history.

You can call CalendarService::parseICalendarData() to parse an iCalendar file. This function returns a CalendarEvent object that's created using information from the iCalendar file. To retrieve information about the original iCalendar file (in the form of an ICalendarData object), you can call CalendarEvent::iCalendarData().


Overview

Public Functions Index

ICalendarData ()
ICalendarData (const ICalendarData &other)
~ICalendarData ()
QStringbodyMimeType () const
QStringcomment () const
unsigned inteventSequence () const
MeetingHistoryhistory () const
boolisValid () const
QStringmethod () const
ICalendarData &operator= (const ICalendarData &other)
QDateTimeoriginalStartTime () const
voidsetBodyMimeType (const QString &bodyMimeType)
voidsetComment (const QString &comment)
voidsetEventSequence (unsigned int eventSequence)
voidsetHistory (const MeetingHistory &history)
voidsetMethod (const QString &method)
voidsetOriginalStartTime (const QDateTime &originalStartTime)

Public Functions

ICalendarData ()

Constructs a new ICalendarData.

Since:

BlackBerry 10.0.0

ICalendarData (

Copy constructor.

This function constructs an ICalendarData containing exactly the same values as the provided ICalendarData.

Parameters
other

The ICalendarData to be copied.

Since:

BlackBerry 10.0.0

~ICalendarData ()

Destructor.

Since:

BlackBerry 10.0.0

QString bodyMimeType ()

Retrieves the MIME type for the body of this ICalendarData.

This function returns the MIME type for the body from the iCalendar file.

Return:

The MIME type for the body of this ICalendarData.

Since:

BlackBerry 10.2.0

QString comment ()

Retrieves the comments of this ICalendarData.

This function returns the comments from the iCalendar file.

Return:

The comments of this ICalendarData.

Since:

BlackBerry 10.0.0

unsigned int eventSequence ()

Retrieves the sequence number of this ICalendarData.

This function returns the attribute in the iCalendar file that increases for each new version of the event.

Return:

The sequence number of this ICalendarData.

Since:

BlackBerry 10.0.0

MeetingHistory history ()

Retrieves the meeting history of this ICalendarData.

This function returns the local database history of the event that's associated with the iCalendar file.

Return:

The meeting history of this ICalendarData.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates whether this ICalendarData is valid.

This function determines whether the attributes of this ICalendarData object have acceptable values.

Return:

True if this ICalendarData is valid, false otherwise.

Since:

BlackBerry 10.0.0

QString method ()

Retrieves the iCalendar method of this ICalendarData.

This function returns the method attribute in the iCalendar file: REPLY, REQUEST, or CANCEL.

Return:

The iCalendar method of this ICalendarData.

Since:

BlackBerry 10.0.0

ICalendarData & operator= (

Assignment operator.

This operator copies all values from the provided ICalendarData into this ICalendarData.

Parameters
other

The ICalendarData from which to copy all values.

Return:

A reference to this ICalendarData.

Since:

BlackBerry 10.0.0

QDateTime originalStartTime ()

Retrieves the original start time of this ICalendarData.

This function returns the original start time from the iCalendar file.

Return:

The original start time of this ICalendarData.

Since:

BlackBerry 10.2.0

void setBodyMimeType (

Sets the MIME type for the body of this ICalendarData.

Parameters
bodyMimeType

The new MIME type.

Since:

BlackBerry 10.2.0

void setComment (

Sets the comments of this ICalendarData.

Parameters
comment

The new comments.

Since:

BlackBerry 10.0.0

void setEventSequence (
  • unsigned inteventSequence)

Sets the sequence number of this ICalendarData.

Parameters
eventSequence

The new sequence number.

Since:

BlackBerry 10.0.0

void setHistory (

Sets the meeting history of this ICalendarData.

Parameters
history

The new meeting history.

Since:

BlackBerry 10.0.0

void setMethod (

Sets the iCalendar method of this ICalendarData.

Parameters
method

The new iCalendar method.

Since:

BlackBerry 10.0.0

void setOriginalStartTime (

Sets the original start time of this ICalendarData.

Parameters
originalStartTime

The new original start time.

Since:

BlackBerry 10.2.0

Last modified: 2014-09-30



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus