CalDAV Class

Properties   Methods   Events   Config Settings   Errors  

The CalDAV Class implements an easy-to-use interface to the Calendaring Extensions to the Web Distributed Authoring and Versioning protocol (WebDAV). In this manner the CalDAV protocol specifies a standard way of accessing, managing, and sharing calendar events based on the iCalendar format.

Syntax

CalDAV

Remarks

The CalDAV &class allows remote management of calendars and their events. Supported operations include creation, deletion, listing, copying, and moving of events. Resource locking is also supported.

The GetCalendarReport method will list the event resources contained in the calendar, and the ReportFilter can be used to limit the results returned. The EventDetails event will be fired for each matching calendar resource. You may also request a report containing a list of times that the owner is free or busy using the GetFreeBusyReport. The FreeBusy event will fire for each entry received, and the data fired in the event will also be stored in the FreeBusy property.

Single events can be added to a calendar (or updated) using the CreateEvent method, and can be retrieved via the GetEvent method. Events may be copied or moved with the CopyEvent and MoveEvent.

The following properties are used when creating a request with CreateEvent or ExportICS, and will be filled after calling GetEvent or ImportICS. These will also be available from inside the EventDetails event, which is fired for each event received from the CalDAV server in response to a GetCalendarReport.

• Alarms
• Attendees
• Categories
• Classification
• Completed
• Created
• CustomProperties
• Depth
• Description
• Duration
• EndDate
• EventType
• LastModified
• Location
• Organizer
• Priority
• Recurrence
• Sequence
• StartDate
• Status
• Summary
• Timestamp
• Timezone
• Transparency
• UID
• URL

Each method that acts on the calendar takes a ResourceURI parameter, which points to either an event resource or to the calendar itself. Event resources have a URI that ends with a filename and the ".ics" extension. Calendar resources end in a directory path. The following methods all act on events, and thus their ResourceURI parameters must terminate in a filename with the ".ics" extension:

• CopyEvent
• DeleteEvent
• MoveEvent
• GetEvent
• CreateEvent

• CreateCalendar
• GetCalendarOptions
• GetCalendarReport
• GetFreeBusyReport

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://apidata.googleusercontent.com/caldav/v2/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the CreateEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetEvent. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Alarms Property (CalDAV Class)

An alarm related to the event.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksCalAlarm>* GetAlarms();
int SetAlarms(IPWorksList<IPWorksCalAlarm>* val);

int ipworks_caldav_getalarmcount(void* lpObj);
int ipworks_caldav_setalarmcount(void* lpObj, int iAlarmCount);

int ipworks_caldav_getalarmaction(void* lpObj, int alarmindex);
int ipworks_caldav_setalarmaction(void* lpObj, int alarmindex, int iAlarmAction);

char* ipworks_caldav_getalarmattachment(void* lpObj, int alarmindex);
int ipworks_caldav_setalarmattachment(void* lpObj, int alarmindex, const char* lpszAlarmAttachment);

char* ipworks_caldav_getalarmattachmenttype(void* lpObj, int alarmindex);
int ipworks_caldav_setalarmattachmenttype(void* lpObj, int alarmindex, const char* lpszAlarmAttachmentType);

char* ipworks_caldav_getalarmduration(void* lpObj, int alarmindex);
int ipworks_caldav_setalarmduration(void* lpObj, int alarmindex, const char* lpszAlarmDuration);

char* ipworks_caldav_getalarmmessage(void* lpObj, int alarmindex);
int ipworks_caldav_setalarmmessage(void* lpObj, int alarmindex, const char* lpszAlarmMessage);

char* ipworks_caldav_getalarmrecipient(void* lpObj, int alarmindex);
int ipworks_caldav_setalarmrecipient(void* lpObj, int alarmindex, const char* lpszAlarmRecipient);

int ipworks_caldav_getalarmrepeat(void* lpObj, int alarmindex);
int ipworks_caldav_setalarmrepeat(void* lpObj, int alarmindex, int iAlarmRepeat);

char* ipworks_caldav_getalarmsubject(void* lpObj, int alarmindex);
int ipworks_caldav_setalarmsubject(void* lpObj, int alarmindex, const char* lpszAlarmSubject);

char* ipworks_caldav_getalarmtrigger(void* lpObj, int alarmindex);
int ipworks_caldav_setalarmtrigger(void* lpObj, int alarmindex, const char* lpszAlarmTrigger);

int GetAlarmCount();
int SetAlarmCount(int iAlarmCount);

int GetAlarmAction(int iAlarmIndex);
int SetAlarmAction(int iAlarmIndex, int iAlarmAction);

QString GetAlarmAttachment(int iAlarmIndex);
int SetAlarmAttachment(int iAlarmIndex, QString qsAlarmAttachment);

QString GetAlarmAttachmentType(int iAlarmIndex);
int SetAlarmAttachmentType(int iAlarmIndex, QString qsAlarmAttachmentType);

QString GetAlarmDuration(int iAlarmIndex);
int SetAlarmDuration(int iAlarmIndex, QString qsAlarmDuration);

QString GetAlarmMessage(int iAlarmIndex);
int SetAlarmMessage(int iAlarmIndex, QString qsAlarmMessage);

QString GetAlarmRecipient(int iAlarmIndex);
int SetAlarmRecipient(int iAlarmIndex, QString qsAlarmRecipient);

int GetAlarmRepeat(int iAlarmIndex);
int SetAlarmRepeat(int iAlarmIndex, int iAlarmRepeat);

QString GetAlarmSubject(int iAlarmIndex);
int SetAlarmSubject(int iAlarmIndex, QString qsAlarmSubject);

QString GetAlarmTrigger(int iAlarmIndex);
int SetAlarmTrigger(int iAlarmIndex, QString qsAlarmTrigger);

Remarks

This property contains the information for an Alarm calendar component. An Alarm calendar component is a grouping of fields that set up a reminder or alarm for an event or to-do. For example, it may be used to define a reminder for a pending event or an overdue to-do.

Each CalAlarm calendar component MUST include the Action and Trigger fields. The Action field further constrains the CalAlarm in the following ways:

When the Action is aAudio, the alarm can optionally include an Attachment field, containing a base-64 encoded binary audio file to be played when the alarm is triggered.

When the Action is aDisplay, the alarm MUST also include the Message field, which contains the text to be displayed when the alarm is triggered.

When the Action is aEmail, the alarm MUST include the Message field, which contains the text to be used as the message body, the Subject field, which contains the text to be used as the message subject, and the Recipient field, which contains the email address of the person intended to receive the message.

An event may contain multiple alarms.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

IPWorksCalAlarm

Attendees Property (CalDAV Class)

Defines one or more participants that have been invited to the event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttendees();
int SetAttendees(const char* lpszAttendees);

Unicode (Windows)
LPWSTR GetAttendees();
INT SetAttendees(LPCWSTR lpszAttendees);

char* ipworks_caldav_getattendees(void* lpObj);
int ipworks_caldav_setattendees(void* lpObj, const char* lpszAttendees);

QString GetAttendees();
int SetAttendees(QString qsAttendees);

Default Value

""

Remarks

This property may contain a comma-separated list of attendees that have been invited to an event. Each email address should be in the mailto URI format (as defined in RFC2368). For instance: CalDAV.Attendees = "mailto:johnsmith@example.com,mailto:janedoe@test.com"

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

Authorization Property (CalDAV Class)

This property includes the Authorization string to be sent to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization);

Unicode (Windows)
LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);

char* ipworks_caldav_getauthorization(void* lpObj);
int ipworks_caldav_setauthorization(void* lpObj, const char* lpszAuthorization);

QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

Default Value

""

Remarks

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

Data Type

String

AuthScheme Property (CalDAV Class)

This property specifies the authentication scheme to use when server authentication is required.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthScheme();
int SetAuthScheme(int iAuthScheme);

Unicode (Windows)
INT GetAuthScheme();
INT SetAuthScheme(INT iAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5), 
AUTH_OAUTH(6)

int ipworks_caldav_getauthscheme(void* lpObj);
int ipworks_caldav_setauthscheme(void* lpObj, int iAuthScheme);

int GetAuthScheme();
int SetAuthScheme(int iAuthScheme);

Default Value

0

Remarks

This property will tell the class which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the class will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the class.

For security, changing the value of this property will cause the class to clear the values of User, Password, and Authorization.

Data Type

Integer

Calendars Property (CalDAV Class)

A collection of calendars.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksCalCalendarInfo>* GetCalendars();
int SetCalendars(IPWorksList<IPWorksCalCalendarInfo>* val);

int ipworks_caldav_getcalendarcount(void* lpObj);
int ipworks_caldav_setcalendarcount(void* lpObj, int iCalendarCount);

char* ipworks_caldav_getcalendarcolor(void* lpObj, int calendarindex);
int ipworks_caldav_setcalendarcolor(void* lpObj, int calendarindex, const char* lpszCalendarColor);

char* ipworks_caldav_getcalendarctag(void* lpObj, int calendarindex);
int ipworks_caldav_setcalendarctag(void* lpObj, int calendarindex, const char* lpszCalendarCTag);

char* ipworks_caldav_getcalendardescription(void* lpObj, int calendarindex);
int ipworks_caldav_setcalendardescription(void* lpObj, int calendarindex, const char* lpszCalendarDescription);

char* ipworks_caldav_getcalendardisplayname(void* lpObj, int calendarindex);
int ipworks_caldav_setcalendardisplayname(void* lpObj, int calendarindex, const char* lpszCalendarDisplayName);

int ipworks_caldav_getcalendarpropertycount(void* lpObj, int calendarindex);

int ipworks_caldav_getcalendarpropertyindex(void* lpObj, int calendarindex);
int ipworks_caldav_setcalendarpropertyindex(void* lpObj, int calendarindex, int iCalendarPropertyIndex);

char* ipworks_caldav_getcalendarpropertyname(void* lpObj, int calendarindex);

char* ipworks_caldav_getcalendarpropertyvalue(void* lpObj, int calendarindex);

char* ipworks_caldav_getcalendarurl(void* lpObj, int calendarindex);
int ipworks_caldav_setcalendarurl(void* lpObj, int calendarindex, const char* lpszCalendarURL);

int GetCalendarCount();
int SetCalendarCount(int iCalendarCount);

QString GetCalendarColor(int iCalendarIndex);
int SetCalendarColor(int iCalendarIndex, QString qsCalendarColor);

QString GetCalendarCTag(int iCalendarIndex);
int SetCalendarCTag(int iCalendarIndex, QString qsCalendarCTag);

QString GetCalendarDescription(int iCalendarIndex);
int SetCalendarDescription(int iCalendarIndex, QString qsCalendarDescription);

QString GetCalendarDisplayName(int iCalendarIndex);
int SetCalendarDisplayName(int iCalendarIndex, QString qsCalendarDisplayName);

int GetCalendarPropertyCount(int iCalendarIndex);

int GetCalendarPropertyIndex(int iCalendarIndex);
int SetCalendarPropertyIndex(int iCalendarIndex, int iCalendarPropertyIndex);

QString GetCalendarPropertyName(int iCalendarIndex);

QString GetCalendarPropertyValue(int iCalendarIndex);

QString GetCalendarURL(int iCalendarIndex);
int SetCalendarURL(int iCalendarIndex, QString qsCalendarURL);

Remarks

This collection will hold data for each CalCalendarInfo available to the current user. Calling ListCalendars will populate this collection.

Data Type

IPWorksCalCalendarInfo

Categories Property (CalDAV Class)

Used to specify categories or subtypes of the calendar event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCategories();
int SetCategories(const char* lpszCategories);

Unicode (Windows)
LPWSTR GetCategories();
INT SetCategories(LPCWSTR lpszCategories);

char* ipworks_caldav_getcategories(void* lpObj);
int ipworks_caldav_setcategories(void* lpObj, const char* lpszCategories);

QString GetCategories();
int SetCategories(QString qsCategories);

Default Value

""

Remarks

This property is used to specify the categories or subtypes contained in a calendar event. The categories are useful in searching for an event of a particular type and/or category. Within the "VEVENT", "VTODO", or "VJOURNAL" calendar components, more than one category can be specified as a COMMA-separated list of categories. For example: CalDAV.CalendarEvents[0].Category = "APPOINTMENT,EDUCATION,MEETING";

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

Classification Property (CalDAV Class)

Defines the access classification for a calendar class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClassification();
int SetClassification(const char* lpszClassification);

Unicode (Windows)
LPWSTR GetClassification();
INT SetClassification(LPCWSTR lpszClassification);

char* ipworks_caldav_getclassification(void* lpObj);
int ipworks_caldav_setclassification(void* lpObj, const char* lpszClassification);

QString GetClassification();
int SetClassification(QString qsClassification);

Default Value

""

Remarks

This property provides a method for capturing the access that the owner wishes to allow for the calendar component. Standard values include "PUBLIC", "PRIVATE", and "CONFIDENTIAL", but calendars may support additional values as well as user-defined values. If not specified, the default value is PUBLIC. Applications MUST treat Classification values that they do not recognize the same way as they would the PRIVATE value.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

Completed Property (CalDAV Class)

Date and time that a to-do was actually completed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCompleted();
int SetCompleted(const char* lpszCompleted);

Unicode (Windows)
LPWSTR GetCompleted();
INT SetCompleted(LPCWSTR lpszCompleted);

char* ipworks_caldav_getcompleted(void* lpObj);
int ipworks_caldav_setcompleted(void* lpObj, const char* lpszCompleted);

QString GetCompleted();
int SetCompleted(QString qsCompleted);

Default Value

""

Remarks

This property defines the date and time that a to-do was actually completed. This property is only applicable for the vTodo EventType. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

Connected Property (CalDAV Class)

Whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworks_caldav_getconnected(void* lpObj);

bool GetConnected();

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

Data Type

Boolean

Cookies Property (CalDAV Class)

A collection of cookies.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksHTTPCookie>* GetCookies();
int SetCookies(IPWorksList<IPWorksHTTPCookie>* val);

int ipworks_caldav_getcookiecount(void* lpObj);
int ipworks_caldav_setcookiecount(void* lpObj, int iCookieCount);

char* ipworks_caldav_getcookiedomain(void* lpObj, int cookieindex);

char* ipworks_caldav_getcookieexpiration(void* lpObj, int cookieindex);

char* ipworks_caldav_getcookiename(void* lpObj, int cookieindex);
int ipworks_caldav_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);

char* ipworks_caldav_getcookiepath(void* lpObj, int cookieindex);

int ipworks_caldav_getcookiesecure(void* lpObj, int cookieindex);

char* ipworks_caldav_getcookievalue(void* lpObj, int cookieindex);
int ipworks_caldav_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);

int GetCookieCount();
int SetCookieCount(int iCookieCount);

QString GetCookieDomain(int iCookieIndex);

QString GetCookieExpiration(int iCookieIndex);

QString GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, QString qsCookieName);

QString GetCookiePath(int iCookieIndex);

bool GetCookieSecure(int iCookieIndex);

QString GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, QString qsCookieValue);

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This property is not available at design time.

Data Type

IPWorksHTTPCookie

CustomProperties Property (CalDAV Class)

List of extra properties that may be used to extend the functionality of this class.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksCalCustomProp>* GetCustomProperties();
int SetCustomProperties(IPWorksList<IPWorksCalCustomProp>* val);

int ipworks_caldav_getcustompropertycount(void* lpObj);
int ipworks_caldav_setcustompropertycount(void* lpObj, int iCustomPropertyCount);

char* ipworks_caldav_getcustompropertyattribute(void* lpObj, int custompropertyindex);
int ipworks_caldav_setcustompropertyattribute(void* lpObj, int custompropertyindex, const char* lpszCustomPropertyAttribute);

char* ipworks_caldav_getcustompropertyname(void* lpObj, int custompropertyindex);
int ipworks_caldav_setcustompropertyname(void* lpObj, int custompropertyindex, const char* lpszCustomPropertyName);

char* ipworks_caldav_getcustompropertyvalue(void* lpObj, int custompropertyindex);
int ipworks_caldav_setcustompropertyvalue(void* lpObj, int custompropertyindex, const char* lpszCustomPropertyValue);

int GetCustomPropertyCount();
int SetCustomPropertyCount(int iCustomPropertyCount);

QString GetCustomPropertyAttribute(int iCustomPropertyIndex);
int SetCustomPropertyAttribute(int iCustomPropertyIndex, QString qsCustomPropertyAttribute);

QString GetCustomPropertyName(int iCustomPropertyIndex);
int SetCustomPropertyName(int iCustomPropertyIndex, QString qsCustomPropertyName);

QString GetCustomPropertyValue(int iCustomPropertyIndex);
int SetCustomPropertyValue(int iCustomPropertyIndex, QString qsCustomPropertyValue);

Remarks

This property is used to add additional name/value pairs to the request. It is valid only for the CreateEvent and CreateCalendar methods. You may use this property to submit any CalDAV fields that are not directly supported by this class. You may also use it to send custom properties that are specific on the calendar that you are using. Such custom properties normally start with "X-". For instance: CalDAV.CustomProperties.Add(new CalCustomProp("X-foo", "bar"));

Or alternatively: CalDAV.CustomProperties.Add(new CalCustomProp()); CalDAV.CustomProperties[0].Name = "X-hello"; CalDAV.CustomProperties[0].Value = "world";

The contents of the CustomProperties collection will only be added to the CreateEvent or CreateCalendar requests. They will be ignored for all other methods.

This property is not available at design time.

Data Type

IPWorksCalCustomProp

Description Property (CalDAV Class)

Provides a complete description of the calendar event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDescription();
int SetDescription(const char* lpszDescription);

Unicode (Windows)
LPWSTR GetDescription();
INT SetDescription(LPCWSTR lpszDescription);

char* ipworks_caldav_getdescription(void* lpObj);
int ipworks_caldav_setdescription(void* lpObj, const char* lpszDescription);

QString GetDescription();
int SetDescription(QString qsDescription);

Default Value

""

Remarks

This property provides a more complete description of the event than is provided by the Summary property.

Data Type

String

DueDate Property (CalDAV Class)

Specifies the due date for a calendar event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDueDate();
int SetDueDate(const char* lpszDueDate);

Unicode (Windows)
LPWSTR GetDueDate();
INT SetDueDate(LPCWSTR lpszDueDate);

char* ipworks_caldav_getduedate(void* lpObj);
int ipworks_caldav_setduedate(void* lpObj, const char* lpszDueDate);

QString GetDueDate();
int SetDueDate(QString qsDueDate);

Default Value

""

Remarks

This setting can be used to configure or obtain the due date for the selected calendar event.

Note: The format of this property should be the same as EndDate.

Data Type

String

Duration Property (CalDAV Class)

Duration of the calendar event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDuration();
int SetDuration(const char* lpszDuration);

Unicode (Windows)
LPWSTR GetDuration();
INT SetDuration(LPCWSTR lpszDuration);

char* ipworks_caldav_getduration(void* lpObj);
int ipworks_caldav_setduration(void* lpObj, const char* lpszDuration);

QString GetDuration();
int SetDuration(QString qsDuration);

Default Value

""

Remarks

This property contains the duration for a calendar event. Durations are represented by the format P<date>T<time>. The date component may contain a number of days or weeks (but not months or years), and the time component may consist of hours, minutes, and seconds. These are represented by an integer value followed by a letter representing the units, as specified by the table below:

This format is based on ISO-8601, but unlike the ISO specification this duration property does not support durations measured in years or months.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

EndDate Property (CalDAV Class)

Specifies the date and time that a calendar event ends.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEndDate();
int SetEndDate(const char* lpszEndDate);

Unicode (Windows)
LPWSTR GetEndDate();
INT SetEndDate(LPCWSTR lpszEndDate);

char* ipworks_caldav_getenddate(void* lpObj);
int ipworks_caldav_setenddate(void* lpObj, const char* lpszEndDate);

QString GetEndDate();
int SetEndDate(QString qsEndDate);

Default Value

""

Remarks

This property specifies the date and time that a calendar event will end. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

ETag Property (CalDAV Class)

Identifier returned by the CalDAV server which is used to synchronize edits.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetETag();
int SetETag(const char* lpszETag);

Unicode (Windows)
LPWSTR GetETag();
INT SetETag(LPCWSTR lpszETag);

char* ipworks_caldav_getetag(void* lpObj);
int ipworks_caldav_setetag(void* lpObj, const char* lpszETag);

QString GetETag();
int SetETag(QString qsETag);

Default Value

""

Remarks

This property identifies the state of the event in the calendar. An ETag is returned by the CalDAV server after a successful CreateEvent request. Every time an event is updated, the ETag changes. This gives you the ability to determine if another user has changed the event you added.

You can use this ETag value to maintain a cache. If you submit a GetCalendarReport request with the ReturnCalendarData field set to False only the URI and ETags for each event in the calendar will be returned in the report. You can cache the ETag and URI locally, and then inspect the report for any changes and update only the events that have changed ETags.

When updating an event with the CreateEvent method, you may add the ETag to the "If-Match" header (using OtherHeaders) in order to insure that you are not overwriting more recent changes on the server. For instance: calDAV.UID = "20110202T000000Z-6414-500-10112-204@nsoftest"; calDAV.StartDate = "20110202T000000Z"; calDAV.EndDate = "20110202T110000Z"; calDAV.TimeStamp = "20100301T000000Z"; calDAV.Summary = "Dinner with friends"; calDAV.Description = "Getting everyone together for some food and fun"; calDAV.Location = "The James Joyce Irish Pub"; calDAV.EventType = CaldavsEventTypes.vEvent; calDAV.OtherHeaders = "If-Match: 1900-1900\r\ n"; calDAV.CreateEvent "https://caldav.calendar.yahoo.com/dav/user_name/Calendar/My_Calendar/20110202T000000Z-6414-500-10112-204@nsoftest.ics" If the current ETag for the above event is "1900-1900", then the above modification will work perfectly. However, if the event was modified on the Yahoo server, the ETag will not match and the above will fail with an HTTP Protocol error: "409 Conflict". In that case you should retrieve the event with GetEvent and update the most recent version.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

EventType Property (CalDAV Class)

Indicates the type of calendar object resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEventType();
int SetEventType(int iEventType);

Unicode (Windows)
INT GetEventType();
INT SetEventType(INT iEventType);

V_EVENT(0), 
V_TODO(1), 
V_JOURNAL(2), 
V_FREE_BUSY(3)

int ipworks_caldav_geteventtype(void* lpObj);
int ipworks_caldav_seteventtype(void* lpObj, int iEventType);

int GetEventType();
int SetEventType(int iEventType);

Default Value

0

Remarks

This property indicates the type of calendar object resource is used.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

Integer

Firewall Property (CalDAV Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

IPWorksFirewall* GetFirewall();
int SetFirewall(IPWorksFirewall* val);

int ipworks_caldav_getfirewallautodetect(void* lpObj);
int ipworks_caldav_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworks_caldav_getfirewalltype(void* lpObj);
int ipworks_caldav_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworks_caldav_getfirewallhost(void* lpObj);
int ipworks_caldav_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworks_caldav_getfirewallpassword(void* lpObj);
int ipworks_caldav_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworks_caldav_getfirewallport(void* lpObj);
int ipworks_caldav_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworks_caldav_getfirewalluser(void* lpObj);
int ipworks_caldav_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

IPWorksFirewall

FollowRedirects Property (CalDAV Class)

Determines what happens when the server issues a redirect.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Unicode (Windows)
INT GetFollowRedirects();
INT SetFollowRedirects(INT iFollowRedirects);

FR_NEVER(0), 
FR_ALWAYS(1), 
FR_SAME_SCHEME(2)

int ipworks_caldav_getfollowredirects(void* lpObj);
int ipworks_caldav_setfollowredirects(void* lpObj, int iFollowRedirects);

int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the class fails with an error instead.

Data Type

Integer

FreeBusy Property (CalDAV Class)

Specifies the times when the calendar owner is free or busy.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksCalFreeBusy>* GetFreeBusy();

int ipworks_caldav_getfreebusycount(void* lpObj);

char* ipworks_caldav_getfreebusyrange(void* lpObj, int freebusyindex);

char* ipworks_caldav_getfreebusytype(void* lpObj, int freebusyindex);

int GetFreeBusyCount();

QString GetFreeBusyRange(int iFreeBusyIndex);

QString GetFreeBusyType(int iFreeBusyIndex);

Remarks

This property may contain free/busy information in response to a GetFreeBusyReport request or after either a GetCalendarReport or a GetEvent request. In the latter case, this property will only contain data when the EventType is vFreeBusy.

This property is read-only.

Data Type

IPWorksCalFreeBusy

Idle Property (CalDAV Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworks_caldav_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LastModified Property (CalDAV Class)

The date and time that the information associated with the calendar event was last revised in the calendar store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLastModified();
int SetLastModified(const char* lpszLastModified);

Unicode (Windows)
LPWSTR GetLastModified();
INT SetLastModified(LPCWSTR lpszLastModified);

char* ipworks_caldav_getlastmodified(void* lpObj);
int ipworks_caldav_setlastmodified(void* lpObj, const char* lpszLastModified);

QString GetLastModified();
int SetLastModified(QString qsLastModified);

Default Value

""

Remarks

This property contains the date and time that the information associated with the calendar event was last revised in the calendar store. This is analogous to the modification date and time for a file in the file system, and must be specified in the UTC time format: <date>T<time>Z, where date is in "YYYYMMDD" format and time is in "hhmmss" format. "T" is the delimiter between date and time, and "Z" is the UTC timezone indicator. For example, "20020119T13:23:56Z" is 1:23:56pm on January 19th, 2002. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

LocalHost Property (CalDAV Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworks_caldav_getlocalhost(void* lpObj);
int ipworks_caldav_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

Location Property (CalDAV Class)

Defines the intended venue for the activity defined by a calendar class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocation();
int SetLocation(const char* lpszLocation);

Unicode (Windows)
LPWSTR GetLocation();
INT SetLocation(LPCWSTR lpszLocation);

char* ipworks_caldav_getlocation(void* lpObj);
int ipworks_caldav_setlocation(void* lpObj, const char* lpszLocation);

QString GetLocation();
int SetLocation(QString qsLocation);

Default Value

""

Remarks

This property may be used to explicitly specify the venue, such as conference or meeting rooms, for the activity defined by a calendar component. An alternate representation may be specified using a URI that points to directory information with more structured specifications of the location. For example, the alternate representation may specify either an LDAP URL [RFC4516] pointing to an LDAP server entry or a CID URL [RFC2392] pointing to a MIME body part containing a Virtual-Information Card (vCard) [RFC2426] for the location.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

LockProperties Property (CalDAV Class)

Fields used when locking and unlocking a calendar resource.

Syntax

• C++
• C
• Qt

IPWorksCalLock* GetLockProperties();
int SetLockProperties(IPWorksCalLock* val);

char* ipworks_caldav_getlocktype(void* lpObj);
int ipworks_caldav_setlocktype(void* lpObj, const char* lpszLockType);

char* ipworks_caldav_getlockowner(void* lpObj);
int ipworks_caldav_setlockowner(void* lpObj, const char* lpszLockOwner);

char* ipworks_caldav_getlockscope(void* lpObj);
int ipworks_caldav_setlockscope(void* lpObj, const char* lpszLockScope);

int ipworks_caldav_getlocktimeout(void* lpObj);
int ipworks_caldav_setlocktimeout(void* lpObj, int iLockTimeout);

char* ipworks_caldav_getlocktoken(void* lpObj);
int ipworks_caldav_setlocktoken(void* lpObj, const char* lpszLockToken);

QString GetLockType();
int SetLockType(QString qsLockType);

QString GetLockOwner();
int SetLockOwner(QString qsLockOwner);

QString GetLockScope();
int SetLockScope(QString qsLockScope);

int GetLockTimeout();
int SetLockTimeout(int iLockTimeout);

QString GetLockToken();
int SetLockToken(QString qsLockToken);

Remarks

This property used the LockType, Owner, Scope Timeout, and Token fields when locking and unlocking a calendar resource. You may lock the whole calendar, or only a single event within the calendar, depending on the URI you pass to LockCalendar or UnLockCalendar. After a successful LockCalendar operation, the class will the LockType, Owner, Scope Timeout, and Token fields to the values returned in the server's response. The lock Token is then passed along when you call CopyEvent or MoveEvent

Data Type

IPWorksCalLock

Organizer Property (CalDAV Class)

Defines the organizer of a calendar event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOrganizer();
int SetOrganizer(const char* lpszOrganizer);

Unicode (Windows)
LPWSTR GetOrganizer();
INT SetOrganizer(LPCWSTR lpszOrganizer);

char* ipworks_caldav_getorganizer(void* lpObj);
int ipworks_caldav_setorganizer(void* lpObj, const char* lpszOrganizer);

QString GetOrganizer();
int SetOrganizer(QString qsOrganizer);

Default Value

""

Remarks

This property is specified within the vEvent, vTodo, and vJournal calendar EventTypes to specify the organizer of a group-scheduled calendar entity. The property is specified within the vFreeBusy EventType to identify the calendar user requesting the free or busy time. When publishing a vFreeBusy EventType, the property is used to specify the calendar that the published busy time came from.

Each email address should be in the mailto URI format (as defined in RFC2368).

For instance: CalDAV.Organizer = "mailto:jane_doe@example.com";

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

OtherHeaders Property (CalDAV Class)

Other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* ipworks_caldav_getotherheaders(void* lpObj);
int ipworks_caldav_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

For CalDAV, the "If-Match" header is extremely useful. After adding a an event with CreateEvent or retrieving an event with GetEvent, the ETag property will contain a value indicating the current state of the event. If you wish to update the event, you may pass this returned ETag in an "If-Match" header. If the event on the server has been modified since you retrieved it (and the ETag on the server has changed), then the CreateEvent will fail with an HTTP Protocol Error: "409 Conflict", which indicates there is a conflict between the version you're trying to update and the current version on the sever. For instance: calDAV.OtherHeaders = "If-Match: 1900-1900\r\ n";

This property is not available at design time.

Data Type

String

ParsedHeaders Property (CalDAV Class)

This property includes a collection of headers returned from the last request.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksHeader>* GetParsedHeaders();

int ipworks_caldav_getparsedheadercount(void* lpObj);

char* ipworks_caldav_getparsedheaderfield(void* lpObj, int parsedheaderindex);

char* ipworks_caldav_getparsedheadervalue(void* lpObj, int parsedheaderindex);

int GetParsedHeaderCount();

QString GetParsedHeaderField(int iParsedHeaderIndex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This property is read-only and not available at design time.

Data Type

IPWorksHeader

Password Property (CalDAV Class)

This property includes a password if authentication is to be used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworks_caldav_getpassword(void* lpObj);
int ipworks_caldav_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

Data Type

String

Priority Property (CalDAV Class)

Defines the relative priority for a calendar event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPriority();
int SetPriority(int iPriority);

Unicode (Windows)
INT GetPriority();
INT SetPriority(INT iPriority);

int ipworks_caldav_getpriority(void* lpObj);
int ipworks_caldav_setpriority(void* lpObj, int iPriority);

int GetPriority();
int SetPriority(int iPriority);

Default Value

0

Remarks

This property defines the relative priority of a calendar event. The priority is specified as an integer in the range 0 to 9. A value of 0 specifies an undefined Priority. A value of 1 is the highest Priority. A value of 2 is the second highest Priority. Subsequent numbers specify a decreasing ordinal Priority. A value of 9 is the lowest Priority.

A Calendar User-Agent (CUA) with a three-level Priority scheme of "HIGH", "MEDIUM", and "LOW" is mapped into this property such that a property value in the range of 1 to 4 specifies "HIGH" Priority. A value of 5 is the normal or "MEDIUM" Priority. A value in the range of 6 to 9 is "LOW" Priority.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

Integer

Proxy Property (CalDAV Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

IPWorksProxy* GetProxy();
int SetProxy(IPWorksProxy* val);

int ipworks_caldav_getproxyauthscheme(void* lpObj);
int ipworks_caldav_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int ipworks_caldav_getproxyautodetect(void* lpObj);
int ipworks_caldav_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* ipworks_caldav_getproxypassword(void* lpObj);
int ipworks_caldav_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int ipworks_caldav_getproxyport(void* lpObj);
int ipworks_caldav_setproxyport(void* lpObj, int iProxyPort);

char* ipworks_caldav_getproxyserver(void* lpObj);
int ipworks_caldav_setproxyserver(void* lpObj, const char* lpszProxyServer);

int ipworks_caldav_getproxyssl(void* lpObj);
int ipworks_caldav_setproxyssl(void* lpObj, int iProxySSL);

char* ipworks_caldav_getproxyuser(void* lpObj);
int ipworks_caldav_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

IPWorksProxy

Recurrence Property (CalDAV Class)

Defines the recurrence set for the event.

Syntax

• C++
• C
• Qt

IPWorksCalRecurrence* GetRecurrence();
int SetRecurrence(IPWorksCalRecurrence* val);

char* ipworks_caldav_getrecurrencedates(void* lpObj);
int ipworks_caldav_setrecurrencedates(void* lpObj, const char* lpszRecurrenceDates);

char* ipworks_caldav_getrecurrenceexceptiondates(void* lpObj);
int ipworks_caldav_setrecurrenceexceptiondates(void* lpObj, const char* lpszRecurrenceExceptionDates);

char* ipworks_caldav_getrecurrenceexceptionrule(void* lpObj);
int ipworks_caldav_setrecurrenceexceptionrule(void* lpObj, const char* lpszRecurrenceExceptionRule);

char* ipworks_caldav_getrecurrenceid(void* lpObj);
int ipworks_caldav_setrecurrenceid(void* lpObj, const char* lpszRecurrenceId);

char* ipworks_caldav_getrecurrencerule(void* lpObj);
int ipworks_caldav_setrecurrencerule(void* lpObj, const char* lpszRecurrenceRule);

QString GetRecurrenceDates();
int SetRecurrenceDates(QString qsRecurrenceDates);

QString GetRecurrenceExceptionDates();
int SetRecurrenceExceptionDates(QString qsRecurrenceExceptionDates);

QString GetRecurrenceExceptionRule();
int SetRecurrenceExceptionRule(QString qsRecurrenceExceptionRule);

QString GetRecurrenceId();
int SetRecurrenceId(QString qsRecurrenceId);

QString GetRecurrenceRule();
int SetRecurrenceRule(QString qsRecurrenceRule);

Remarks

This property defines the recurrence set for the event. The recurrence set is the complete set of recurrence instances for a calendar component. The recurrence set is generated by considering the initial StartDate property along with the Rule, Dates, ExceptionRule, and ExceptionDates fields contained within the recurring event. The StartDate property defines the first instance in the recurrence set. The starting date SHOULD match the pattern of the recurrence rule, if specified. The recurrence set generated with a start date that doesn't match the pattern of the rule is undefined. The final recurrence set is generated by gathering all of the start DATE-TIME values generated by any of the specified Rule and Dates fields, and then excluding any start DATE-TIME values specified by the ExceptionRule or ExceptionDates fields. This implies that DATE-TIME values specified by the ExceptionRule and ExceptionDates fields take precedence over those specified by inclusion properties (i.e., Dates and Rule). When duplicate instances are generated by the recurrence Rule and Dates fields, only one recurrence is considered. Duplicate instances are ignored.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

IPWorksCalRecurrence

RelatedTo Property (CalDAV Class)

Represents a relationship or reference between this calendar event and another.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRelatedTo();
int SetRelatedTo(const char* lpszRelatedTo);

Unicode (Windows)
LPWSTR GetRelatedTo();
INT SetRelatedTo(LPCWSTR lpszRelatedTo);

char* ipworks_caldav_getrelatedto(void* lpObj);
int ipworks_caldav_setrelatedto(void* lpObj, const char* lpszRelatedTo);

QString GetRelatedTo();
int SetRelatedTo(QString qsRelatedTo);

Default Value

""

Remarks

This property is specified within the vEvent, vTodo, and vJournal calendar EventTypes to represent a relationship or reference between this calendar component and another. This value would be represented by the UID property of the event, which this event is related to. The RelatedTo value points to another calendar component that has a PARENT relationship to the referencing object.

Data Type

String

ReportFilter Property (CalDAV Class)

Criteria used to filter reports.

Syntax

• C++
• C
• Qt

IPWorksCalReportFilter* GetReportFilter();
int SetReportFilter(IPWorksCalReportFilter* val);

char* ipworks_caldav_getreportfilteralarmend(void* lpObj);
int ipworks_caldav_setreportfilteralarmend(void* lpObj, const char* lpszReportFilterAlarmEnd);

char* ipworks_caldav_getreportfilteralarmstart(void* lpObj);
int ipworks_caldav_setreportfilteralarmstart(void* lpObj, const char* lpszReportFilterAlarmStart);

char* ipworks_caldav_getreportfiltercustomfilter(void* lpObj);
int ipworks_caldav_setreportfiltercustomfilter(void* lpObj, const char* lpszReportFilterCustomFilter);

char* ipworks_caldav_getreportfilterenddate(void* lpObj);
int ipworks_caldav_setreportfilterenddate(void* lpObj, const char* lpszReportFilterEndDate);

int ipworks_caldav_getreportfiltereventtype(void* lpObj);
int ipworks_caldav_setreportfiltereventtype(void* lpObj, int iReportFilterEventType);

char* ipworks_caldav_getreportfilterproperty(void* lpObj);
int ipworks_caldav_setreportfilterproperty(void* lpObj, const char* lpszReportFilterProperty);

char* ipworks_caldav_getreportfilterrecurend(void* lpObj);
int ipworks_caldav_setreportfilterrecurend(void* lpObj, const char* lpszReportFilterRecurEnd);

char* ipworks_caldav_getreportfilterrecurstart(void* lpObj);
int ipworks_caldav_setreportfilterrecurstart(void* lpObj, const char* lpszReportFilterRecurStart);

int ipworks_caldav_getreportfilterreturncalendardata(void* lpObj);
int ipworks_caldav_setreportfilterreturncalendardata(void* lpObj, int bReportFilterReturnCalendarData);

char* ipworks_caldav_getreportfilterstartdate(void* lpObj);
int ipworks_caldav_setreportfilterstartdate(void* lpObj, const char* lpszReportFilterStartDate);

char* ipworks_caldav_getreportfilteruid(void* lpObj);
int ipworks_caldav_setreportfilteruid(void* lpObj, const char* lpszReportFilterUID);

QString GetReportFilterAlarmEnd();
int SetReportFilterAlarmEnd(QString qsReportFilterAlarmEnd);

QString GetReportFilterAlarmStart();
int SetReportFilterAlarmStart(QString qsReportFilterAlarmStart);

QString GetReportFilterCustomFilter();
int SetReportFilterCustomFilter(QString qsReportFilterCustomFilter);

QString GetReportFilterEndDate();
int SetReportFilterEndDate(QString qsReportFilterEndDate);

int GetReportFilterEventType();
int SetReportFilterEventType(int iReportFilterEventType);

QString GetReportFilterProperty();
int SetReportFilterProperty(QString qsReportFilterProperty);

QString GetReportFilterRecurEnd();
int SetReportFilterRecurEnd(QString qsReportFilterRecurEnd);

QString GetReportFilterRecurStart();
int SetReportFilterRecurStart(QString qsReportFilterRecurStart);

bool GetReportFilterReturnCalendarData();
int SetReportFilterReturnCalendarData(bool bReportFilterReturnCalendarData);

QString GetReportFilterStartDate();
int SetReportFilterStartDate(QString qsReportFilterStartDate);

QString GetReportFilterUID();
int SetReportFilterUID(QString qsReportFilterUID);

Remarks

This property may be used to restrict the results of reports to only those that match your search criteria.The GetCalendarReport method will normally return the entire calendar collection at the specified ResourceURI. You can restrict results to only events within a specified time range (using StartDate and EndDate), to only recurring events within a specified time range (using RecurStart and RecurEnd), and to events with an alarm set to go off within a specified time range. (using AlarmStart and AlarmEnd). You can also restrict results to only those events which contain a specific Property (either by property name, or name and a specific value). The EventType property determines what kind of events are returned (events, todo lists, journal entries, or free/busy time).

Data Type

IPWorksCalReportFilter

Sequence Property (CalDAV Class)

Defines the revision sequence number of the event within a sequence of revisions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSequence();
int SetSequence(int iSequence);

Unicode (Windows)
INT GetSequence();
INT SetSequence(INT iSequence);

int ipworks_caldav_getsequence(void* lpObj);
int ipworks_caldav_setsequence(void* lpObj, int iSequence);

int GetSequence();
int SetSequence(int iSequence);

Default Value

0

Remarks

This property defines the revision sequence number of the event within a sequence of revisions. When a calendar component is created its Sequence number is 0. It is incremented by the Organizer's Calendar User Agent (CUA) each time the Organizer makes a significant revision to the calendar event. Therefore, a Sequence number of 2 means the event has been revised twice.

The Organizer includes this property in a calendar event that it sends to an Attendees to specify the current version of the event. Likewise, the Attendees includes this property in an event that it sends to the Organizer to specify the version of the calendar component to which the Attendees is referring.

Note: Recurrence instances of a recurring event may have different sequence numbers.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

Integer

SSLAcceptServerCert Property (CalDAV Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksCertificate* val);

char* ipworks_caldav_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworks_caldav_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworks_caldav_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworks_caldav_getsslacceptservercertfingerprint(void* lpObj);

char* ipworks_caldav_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworks_caldav_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworks_caldav_getsslacceptservercertissuer(void* lpObj);

char* ipworks_caldav_getsslacceptservercertprivatekey(void* lpObj);

int ipworks_caldav_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworks_caldav_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworks_caldav_getsslacceptservercertpublickey(void* lpObj);

char* ipworks_caldav_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworks_caldav_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworks_caldav_getsslacceptservercertserialnumber(void* lpObj);

char* ipworks_caldav_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworks_caldav_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworks_caldav_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworks_caldav_getsslacceptservercertstorepassword(void* lpObj);
int ipworks_caldav_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworks_caldav_getsslacceptservercertstoretype(void* lpObj);
int ipworks_caldav_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworks_caldav_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworks_caldav_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworks_caldav_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworks_caldav_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworks_caldav_getsslacceptservercertusage(void* lpObj);

int ipworks_caldav_getsslacceptservercertusageflags(void* lpObj);

char* ipworks_caldav_getsslacceptservercertversion(void* lpObj);

char* ipworks_caldav_getsslacceptservercertsubject(void* lpObj);
int ipworks_caldav_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworks_caldav_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_caldav_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

IPWorksCertificate

SSLCert Property (CalDAV Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLCert();
int SetSSLCert(IPWorksCertificate* val);

char* ipworks_caldav_getsslcerteffectivedate(void* lpObj);

char* ipworks_caldav_getsslcertexpirationdate(void* lpObj);

char* ipworks_caldav_getsslcertextendedkeyusage(void* lpObj);

char* ipworks_caldav_getsslcertfingerprint(void* lpObj);

char* ipworks_caldav_getsslcertfingerprintsha1(void* lpObj);

char* ipworks_caldav_getsslcertfingerprintsha256(void* lpObj);

char* ipworks_caldav_getsslcertissuer(void* lpObj);

char* ipworks_caldav_getsslcertprivatekey(void* lpObj);

int ipworks_caldav_getsslcertprivatekeyavailable(void* lpObj);

char* ipworks_caldav_getsslcertprivatekeycontainer(void* lpObj);

char* ipworks_caldav_getsslcertpublickey(void* lpObj);

char* ipworks_caldav_getsslcertpublickeyalgorithm(void* lpObj);

int ipworks_caldav_getsslcertpublickeylength(void* lpObj);

char* ipworks_caldav_getsslcertserialnumber(void* lpObj);

char* ipworks_caldav_getsslcertsignaturealgorithm(void* lpObj);

int ipworks_caldav_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_caldav_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworks_caldav_getsslcertstorepassword(void* lpObj);
int ipworks_caldav_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworks_caldav_getsslcertstoretype(void* lpObj);
int ipworks_caldav_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworks_caldav_getsslcertsubjectaltnames(void* lpObj);

char* ipworks_caldav_getsslcertthumbprintmd5(void* lpObj);

char* ipworks_caldav_getsslcertthumbprintsha1(void* lpObj);

char* ipworks_caldav_getsslcertthumbprintsha256(void* lpObj);

char* ipworks_caldav_getsslcertusage(void* lpObj);

int ipworks_caldav_getsslcertusageflags(void* lpObj);

char* ipworks_caldav_getsslcertversion(void* lpObj);

char* ipworks_caldav_getsslcertsubject(void* lpObj);
int ipworks_caldav_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworks_caldav_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_caldav_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksCertificate

SSLProvider Property (CalDAV Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworks_caldav_getsslprovider(void* lpObj);
int ipworks_caldav_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (CalDAV Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLServerCert();

char* ipworks_caldav_getsslservercerteffectivedate(void* lpObj);

char* ipworks_caldav_getsslservercertexpirationdate(void* lpObj);

char* ipworks_caldav_getsslservercertextendedkeyusage(void* lpObj);

char* ipworks_caldav_getsslservercertfingerprint(void* lpObj);

char* ipworks_caldav_getsslservercertfingerprintsha1(void* lpObj);

char* ipworks_caldav_getsslservercertfingerprintsha256(void* lpObj);

char* ipworks_caldav_getsslservercertissuer(void* lpObj);

char* ipworks_caldav_getsslservercertprivatekey(void* lpObj);

int ipworks_caldav_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworks_caldav_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworks_caldav_getsslservercertpublickey(void* lpObj);

char* ipworks_caldav_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworks_caldav_getsslservercertpublickeylength(void* lpObj);

char* ipworks_caldav_getsslservercertserialnumber(void* lpObj);

char* ipworks_caldav_getsslservercertsignaturealgorithm(void* lpObj);

int ipworks_caldav_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworks_caldav_getsslservercertstorepassword(void* lpObj);

int ipworks_caldav_getsslservercertstoretype(void* lpObj);

char* ipworks_caldav_getsslservercertsubjectaltnames(void* lpObj);

char* ipworks_caldav_getsslservercertthumbprintmd5(void* lpObj);

char* ipworks_caldav_getsslservercertthumbprintsha1(void* lpObj);

char* ipworks_caldav_getsslservercertthumbprintsha256(void* lpObj);

char* ipworks_caldav_getsslservercertusage(void* lpObj);

int ipworks_caldav_getsslservercertusageflags(void* lpObj);

char* ipworks_caldav_getsslservercertversion(void* lpObj);

char* ipworks_caldav_getsslservercertsubject(void* lpObj);

int ipworks_caldav_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksCertificate

StartDate Property (CalDAV Class)

Specifies the date and time that an event begins.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetStartDate();
int SetStartDate(const char* lpszStartDate);

Unicode (Windows)
LPWSTR GetStartDate();
INT SetStartDate(LPCWSTR lpszStartDate);

char* ipworks_caldav_getstartdate(void* lpObj);
int ipworks_caldav_setstartdate(void* lpObj, const char* lpszStartDate);

QString GetStartDate();
int SetStartDate(QString qsStartDate);

Default Value

""

Remarks

This property specifies the date and time that an event begins. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

Status Property (CalDAV Class)

Defines the overall status or confirmation for the calendar event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetStatus();
int SetStatus(const char* lpszStatus);

Unicode (Windows)
LPWSTR GetStatus();
INT SetStatus(LPCWSTR lpszStatus);

char* ipworks_caldav_getstatus(void* lpObj);
int ipworks_caldav_setstatus(void* lpObj, const char* lpszStatus);

QString GetStatus();
int SetStatus(QString qsStatus);

Default Value

""

Remarks

In a group-scheduled calendar component, the property is used by the Organizer to provide a confirmation of the event to the Attendees. For example in a vEvent EventType the Organizer can indicate that a meeting is tentative, confirmed, or canceled. For a vTodo EventType, the Organizer can indicate that an action item needs action, is completed, is in process or being worked on, or has been canceled. In a vJournal EventType, the Organizer can indicate that a journal entry is draft, final, or has been canceled or removed.

Statuses for a vEvent EventType:

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

Summary Property (CalDAV Class)

Defines a short summary or subject for the calendar event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummary();
int SetSummary(const char* lpszSummary);

Unicode (Windows)
LPWSTR GetSummary();
INT SetSummary(LPCWSTR lpszSummary);

char* ipworks_caldav_getsummary(void* lpObj);
int ipworks_caldav_setsummary(void* lpObj, const char* lpszSummary);

QString GetSummary();
int SetSummary(QString qsSummary);

Default Value

""

Remarks

This property defines a short summary or subject for the calendar event.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

Timeout Property (CalDAV Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworks_caldav_gettimeout(void* lpObj);
int ipworks_caldav_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

Timestamp Property (CalDAV Class)

Specifies the date and time that the instance of the event was created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTimestamp();
int SetTimestamp(const char* lpszTimestamp);

Unicode (Windows)
LPWSTR GetTimestamp();
INT SetTimestamp(LPCWSTR lpszTimestamp);

char* ipworks_caldav_gettimestamp(void* lpObj);
int ipworks_caldav_settimestamp(void* lpObj, const char* lpszTimestamp);

QString GetTimestamp();
int SetTimestamp(QString qsTimestamp);

Default Value

""

Remarks

This property specifies the date and time that the instance of the event was created. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

Note: This property must be specified in UTC time format.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

Timezone Property (CalDAV Class)

Specifies a time zone on a calendar collection.

Syntax

• C++
• C
• Qt

IPWorksCalTimezone* GetTimezone();
int SetTimezone(IPWorksCalTimezone* val);

char* ipworks_caldav_gettimezonedstname(void* lpObj);
int ipworks_caldav_settimezonedstname(void* lpObj, const char* lpszTimezoneDSTName);

char* ipworks_caldav_gettimezonedstoffsetfrom(void* lpObj);
int ipworks_caldav_settimezonedstoffsetfrom(void* lpObj, const char* lpszTimezoneDSTOffsetFrom);

char* ipworks_caldav_gettimezonedstoffsetto(void* lpObj);
int ipworks_caldav_settimezonedstoffsetto(void* lpObj, const char* lpszTimezoneDSTOffsetTo);

char* ipworks_caldav_gettimezonedstrule(void* lpObj);
int ipworks_caldav_settimezonedstrule(void* lpObj, const char* lpszTimezoneDSTRule);

char* ipworks_caldav_gettimezonedststart(void* lpObj);
int ipworks_caldav_settimezonedststart(void* lpObj, const char* lpszTimezoneDSTStart);

char* ipworks_caldav_gettimezonelastmodified(void* lpObj);
int ipworks_caldav_settimezonelastmodified(void* lpObj, const char* lpszTimezoneLastModified);

char* ipworks_caldav_gettimezonestdname(void* lpObj);
int ipworks_caldav_settimezonestdname(void* lpObj, const char* lpszTimezoneStdName);

char* ipworks_caldav_gettimezonestdoffsetfrom(void* lpObj);
int ipworks_caldav_settimezonestdoffsetfrom(void* lpObj, const char* lpszTimezoneStdOffsetFrom);

char* ipworks_caldav_gettimezonestdoffsetto(void* lpObj);
int ipworks_caldav_settimezonestdoffsetto(void* lpObj, const char* lpszTimezoneStdOffsetTo);

char* ipworks_caldav_gettimezonestdrule(void* lpObj);
int ipworks_caldav_settimezonestdrule(void* lpObj, const char* lpszTimezoneStdRule);

char* ipworks_caldav_gettimezonestdstart(void* lpObj);
int ipworks_caldav_settimezonestdstart(void* lpObj, const char* lpszTimezoneStdStart);

char* ipworks_caldav_gettimezoneid(void* lpObj);
int ipworks_caldav_settimezoneid(void* lpObj, const char* lpszTimezoneId);

char* ipworks_caldav_gettimezoneurl(void* lpObj);
int ipworks_caldav_settimezoneurl(void* lpObj, const char* lpszTimezoneURL);

QString GetTimezoneDSTName();
int SetTimezoneDSTName(QString qsTimezoneDSTName);

QString GetTimezoneDSTOffsetFrom();
int SetTimezoneDSTOffsetFrom(QString qsTimezoneDSTOffsetFrom);

QString GetTimezoneDSTOffsetTo();
int SetTimezoneDSTOffsetTo(QString qsTimezoneDSTOffsetTo);

QString GetTimezoneDSTRule();
int SetTimezoneDSTRule(QString qsTimezoneDSTRule);

QString GetTimezoneDSTStart();
int SetTimezoneDSTStart(QString qsTimezoneDSTStart);

QString GetTimezoneLastModified();
int SetTimezoneLastModified(QString qsTimezoneLastModified);

QString GetTimezoneStdName();
int SetTimezoneStdName(QString qsTimezoneStdName);

QString GetTimezoneStdOffsetFrom();
int SetTimezoneStdOffsetFrom(QString qsTimezoneStdOffsetFrom);

QString GetTimezoneStdOffsetTo();
int SetTimezoneStdOffsetTo(QString qsTimezoneStdOffsetTo);

QString GetTimezoneStdRule();
int SetTimezoneStdRule(QString qsTimezoneStdRule);

QString GetTimezoneStdStart();
int SetTimezoneStdStart(QString qsTimezoneStdStart);

QString GetTimezoneId();
int SetTimezoneId(QString qsTimezoneId);

QString GetTimezoneURL();
int SetTimezoneURL(QString qsTimezoneURL);

Remarks

This property is used to specify the time zone the server should rely on to resolve "date" values and "date with local time" values (i.e., floating time) to "date with UTC time" values. The server will require this information to determine if a calendar component scheduled with "date" values or "date with local time" values overlap a time range specified in a GetCalendarReport. In the absence of this property, the server may rely on a time zone of its choosing.

This may be specified when adding or modifying an event with the CreateEvent method, and can also specify the default timezone for the calendar when creating a new calendar collection via the CreateCalendar method.

This property may be filled from the response to a GetEvent, and can also be used when creating an event to be added using the CreateEvent method. It is also optional when calling the CreateCalendar method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

IPWorksCalTimezone

Transparency Property (CalDAV Class)

Defines whether or not an event is transparent to busy time searches.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransparency();
int SetTransparency(const char* lpszTransparency);

Unicode (Windows)
LPWSTR GetTransparency();
INT SetTransparency(LPCWSTR lpszTransparency);

char* ipworks_caldav_gettransparency(void* lpObj);
int ipworks_caldav_settransparency(void* lpObj, const char* lpszTransparency);

QString GetTransparency();
int SetTransparency(QString qsTransparency);

Default Value

""

Remarks

This property defines whether or not an event is transparent to busy time searches. Time Transparency is the characteristic of an event that determines whether it appears to consume time on a calendar. Events that consume actual time for the individual or resource associated with the calendar SHOULD be recorded as "OPAQUE", allowing them to be detected by free/busy time searches. Other events, which do not take up the individual's (or resource's) time SHOULD be recorded as "TRANSPARENT", making them invisible to free/ busy time searches.

Custom transparency values may or may not be supported by your calendar implementation, but all implementations will support the "OPAQUE" and "TRANSPARENT" values.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

UID Property (CalDAV Class)

A persistent, globally unique identifier for the calendar event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUID();
int SetUID(const char* lpszUID);

Unicode (Windows)
LPWSTR GetUID();
INT SetUID(LPCWSTR lpszUID);

char* ipworks_caldav_getuid(void* lpObj);
int ipworks_caldav_setuid(void* lpObj, const char* lpszUID);

QString GetUID();
int SetUID(QString qsUID);

Default Value

""

Remarks

This property contains a persistent, globally unique identifier. The generator of the identifier MUST guarantee that the identifier is unique. There are several algorithms that can be used to accomplish this. A good method to assure uniqueness is to put the domain name or a domain literal IP address of the host on which the identifier was created on the right-hand side of an "@", and on the left-hand side, put a combination of the current calendar date and time of day (i.e., formatted in as a date/time value) along with some other currently unique (perhaps sequential) identifier available on the system (for example, a process id number). Using a date/time value on the left-hand side and a domain name or domain literal on the right-hand side makes it possible to guarantee uniqueness since no two hosts should be using the same domain name or IP address at the same time. Though other algorithms will work, it is recommended that the right-hand side contain some domain identifier (either of the host itself or otherwise) such that the generator of the message identifier can guarantee the uniqueness of the left-hand side within the scope of that domain.

NOTE: Some CalDAV servers (Yahoo for example) require that the UID and the filename portion of the Resource URI match. For example, if the UID is "hello_world" then the ResourceURI parameter of the CreateEvent should be "https://caldav.calendar.yahoo.com/dav/user_name/Calendar/My_Calendar/hello_world.ics". If the UID and filename portion of the URI do not match, the Yahoo CalDAV server will return a "302 Found" response indicating that the requested resource resides under a different URI. (Meaning the event was not added to the calendar)

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

String

URL Property (CalDAV Class)

Location of the event resource on the CalDAV server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetURL();

Unicode (Windows)
LPWSTR GetURL();

char* ipworks_caldav_geturl(void* lpObj);

QString GetURL();

Default Value

""

Remarks

This property is read-only, and will be filled with the location of the event resource for each event returned. This will only be returned in response to a GetCalendarReport transaction.

This property is filled from the response to a GetEvent, and is also used when creating an event to be added using the CreateEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

This property is read-only.

Data Type

String

User Property (CalDAV Class)

This property includes a user name if authentication is to be used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworks_caldav_getuser(void* lpObj);
int ipworks_caldav_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

Data Type

String

AddCookie Method (CalDAV Class)

Adds a cookie and the corresponding value to the outgoing request headers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddCookie(const char* lpszCookieName, const char* lpszCookieValue);

Unicode (Windows)
INT AddCookie(LPCWSTR lpszCookieName, LPCWSTR lpszCookieValue);

int ipworks_caldav_addcookie(void* lpObj, const char* lpszCookieName, const char* lpszCookieValue);

int AddCookie(const QString& qsCookieName, const QString& qsCookieValue);

Remarks

This method adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddCustomProperty Method (CalDAV Class)

Adds a form variable and the corresponding value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddCustomProperty(const char* lpszVarName, const char* lpszVarValue);

Unicode (Windows)
INT AddCustomProperty(LPCWSTR lpszVarName, LPCWSTR lpszVarValue);

int ipworks_caldav_addcustomproperty(void* lpObj, const char* lpszVarName, const char* lpszVarValue);

int AddCustomProperty(const QString& qsVarName, const QString& qsVarValue);

Remarks

This property adds a form variable and the corresponding value. For information on form variables and how they are managed, please refer to the CustomProperties properties.

Example using the AddCustomProperty method:

CalDAV.Reset() CalDAV.AddCustomProperty("propname1", "propvalue1") CalDAV.AddCustomProperty("propname2", "propvalue2") Example using Custom Property arrays: CalDAV.Reset() CalDAV.CustomPropertyCount = 2 CalDAV.CustomPropertyName (0) = "propname1" CalDAV.CustomPropertyValue(0) = "propvalue1" CalDAV.CustomPropertyName (1) = "propname2" CalDAV.CustomPropertyValue(1) = "propvalue2"

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (CalDAV Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_caldav_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CopyEvent Method (CalDAV Class)

Copy events to a new location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CopyEvent(const char* lpszSourceResourceURI, const char* lpszDestinationResourceURI);

Unicode (Windows)
INT CopyEvent(LPCWSTR lpszSourceResourceURI, LPCWSTR lpszDestinationResourceURI);

int ipworks_caldav_copyevent(void* lpObj, const char* lpszSourceResourceURI, const char* lpszDestinationResourceURI);

int CopyEvent(const QString& qsSourceResourceURI, const QString& qsDestinationResourceURI);

Remarks

The CopyEvent method will copy the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI.

This method is associated with the Depth property. If Depth is set to "0", the class will copy only SourceResourceURI. If Depth is set to "infinity", the class will copy SourceResourceURI and its entire subtree to the relative locations.

If the user has acquired a LockCalendar of infinite depth on either DestinationResourceURI or any collection it is under, SourceResourceURI will be added to that lock.

Note that neither Yahoo nor Google CalDAV servers support locking, copying, or moving calendar resources.

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://apidata.googleusercontent.com/caldav/v2/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the CreateEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetEvent. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateCalendar Method (CalDAV Class)

Creates a new calendar collection resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateCalendar(const char* lpszResourceURI, const char* lpszDisplayName, const char* lpszDescription);

Unicode (Windows)
INT CreateCalendar(LPCWSTR lpszResourceURI, LPCWSTR lpszDisplayName, LPCWSTR lpszDescription);

int ipworks_caldav_createcalendar(void* lpObj, const char* lpszResourceURI, const char* lpszDisplayName, const char* lpszDescription);

int CreateCalendar(const QString& qsResourceURI, const QString& qsDisplayName, const QString& qsDescription);

Remarks

The CreateCalendar method creates a new calendar collection resource. A server MAY restrict calendar collection creation to particular collections.

Creating calendar collections is not supported by all CalDAV servers. Some calendar stores only support one calendar per user (or principal), and those are typically pre-created for each account.

The DisplayName and Description parameters should be set to a human readable display name and description of the calendar. The Timezone property specifies the default timezone of the calendar.

To successfully create a calendar, the ResourceURI cannot already exist, and must point to a valid location where a new calendar can be created. The DAV:bind privilege MUST be granted to the current user on the parent collection of the specified ResourceURI.

The following example shows how to create a simple new calendar collection resource with Yahoo Calendar. calDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1", "My Display Name", "My Calendar Description);

Note that Google does not support creating a new calendar through CalDAV. It must be created through the Google calendar web interface.

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://apidata.googleusercontent.com/caldav/v2/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the CreateEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetEvent. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateEvent Method (CalDAV Class)

Adds a calendar resource at the specified ResourceURI using the CalDAV PUT method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateEvent(const char* lpszResourceURI);

Unicode (Windows)
INT CreateEvent(LPCWSTR lpszResourceURI);

int ipworks_caldav_createevent(void* lpObj, const char* lpszResourceURI);

int CreateEvent(const QString& qsResourceURI);

Remarks

This method adds a new event to the calendar collection at the specified ResourceURI. The ResourceURI must be a fully qualified URL to the location on the CalDAV server to which this event will be saved. If the ResourceURI already exists, the event at that URI will be overwritten.

NOTE: Some CalDAV servers (Yahoo for example) require that the UID and the filename portion of the URI match. For example, if the UID is "hello_world" then the ResourceURI parameter of the CreateEvent should be "https://caldav.calendar.yahoo.com/dav/user_name/Calendar/My_Calendar/hello_world.ics". If the UID and filename portion of the URI do not match, the Yahoo CalDAV server will return a "302 Found" response indicating that the requested resource resides under a different URI. (Meaning the event was not added to the calendar)

The following properties are used when creating a request with CreateEvent or ExportICS, and will be filled after calling GetEvent or ImportICS. These will also be available from inside the EventDetails event, which is fired for each event received from the CalDAV server in response to a GetCalendarReport.

• Alarms
• Attendees
• Categories
• Classification
• Completed
• Created
• CustomProperties
• Depth
• Description
• Duration
• EndDate
• EventType
• LastModified
• Location
• Organizer
• Priority
• Recurrence
• Sequence
• StartDate
• Status
• Summary
• Timestamp
• Timezone
• Transparency
• UID
• URL

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://apidata.googleusercontent.com/caldav/v2/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the CreateEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetEvent. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteCalendar Method (CalDAV Class)

Deletes a calendar collection resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteCalendar(const char* lpszResourceURI);

Unicode (Windows)
INT DeleteCalendar(LPCWSTR lpszResourceURI);

int ipworks_caldav_deletecalendar(void* lpObj, const char* lpszResourceURI);

int DeleteCalendar(const QString& qsResourceURI);

Remarks

This method deletes a calendar collection resource specified by ResourceURI. To successfully delete a calendar, the ResourceURI should already exist, and must point to a valid location where a calendar can be deleted. The DAV:bind privilege MUST be granted to the current user on the parent collection of the specified ResourceURI.

The following example shows how to delete a calendar collection resource: calDAV.DeleteCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1"); In a NextCloud server, if all calendars are deleted, a new Personal calendar is automatically created.

Note that Google does not support deleting a calendar through CalDAV. It must be created through the Google calendar web interface.

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://apidata.googleusercontent.com/caldav/v2/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the CreateEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetEvent. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteEvent Method (CalDAV Class)

Delete a resource or collection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteEvent(const char* lpszResourceURI);

Unicode (Windows)
INT DeleteEvent(LPCWSTR lpszResourceURI);

int ipworks_caldav_deleteevent(void* lpObj, const char* lpszResourceURI);

int DeleteEvent(const QString& qsResourceURI);

Remarks

This method behaves independently of the Depth property. It is used to delete the resource or collection specified by ResourceURI. If ResourceURI denotes a non-collection resource, it is first removed from any collection in which it is contained, it is then removed from the server. If ResourceURI denotes a collection, the server behaves as if the command were issued with an infinite depth (i.e., all internal member URIs denoting single resources or collections are deleted).

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://apidata.googleusercontent.com/caldav/v2/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the CreateEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetEvent. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (CalDAV Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_caldav_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ExportICS Method (CalDAV Class)

Generates an event from the properties in the iCal (.ICS) format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ExportICS();

Unicode (Windows)
LPWSTR ExportICS();

char* ipworks_caldav_exportics(void* lpObj);

QString ExportICS();

Remarks

The ExportICS method is used to create a calendar object and export it in the iCal/ICS format, which can then be saved to disk and imported using any calendar software, even those that do not support CalDAV. The ExportICS method will create the exact same data as the CreateEvent method sends when adding or updating an event to a calendar.

Note that if ExportICS is called immediately after a successful GetEvent, the unmodified calendar returned from the CalDAV server will be returned. However if any properties are changed between the GetEvent and ExportICS calls, the class will generate and return a brand new event.

The following properties are used when creating a request with CreateEvent or ExportICS, and will be filled after calling GetEvent or ImportICS. These will also be available from inside the EventDetails event, which is fired for each event received from the CalDAV server in response to a GetCalendarReport.

• Alarms
• Attendees
• Categories
• Classification
• Completed
• Created
• CustomProperties
• Depth
• Description
• Duration
• EndDate
• EventType
• LastModified
• Location
• Organizer
• Priority
• Recurrence
• Sequence
• StartDate
• Status
• Summary
• Timestamp
• Timezone
• Transparency
• UID
• URL

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetCalendarOptions Method (CalDAV Class)

Retrieves options for the ResourceURI to determines whether it supports calendar access.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCalendarOptions(const char* lpszResourceURI);

Unicode (Windows)
INT GetCalendarOptions(LPCWSTR lpszResourceURI);

int ipworks_caldav_getcalendaroptions(void* lpObj, const char* lpszResourceURI);

int GetCalendarOptions(const QString& qsResourceURI);

Remarks

This method sends an OPTIONS HTTP request to the indicated ResourceURI. The server will respond with an 200 OK HTTP message, and the supported options will fire one-by-one in the Header event. If a server supports CalDAV calendar access, the "DAV" header will contain the string "calendar-access". The allowable CalDAV and WebDAV methods may also be returned in the "Allow" header.

For instance, the following headers may be returned from a call to the GetCalendarOptions method:

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://apidata.googleusercontent.com/caldav/v2/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the CreateEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetEvent. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetCalendarReport Method (CalDAV Class)

Generates a report on the indicated calendar collection resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCalendarReport(const char* lpszResourceURI);

Unicode (Windows)
INT GetCalendarReport(LPCWSTR lpszResourceURI);

int ipworks_caldav_getcalendarreport(void* lpObj, const char* lpszResourceURI);

int GetCalendarReport(const QString& qsResourceURI);

Remarks

This method is used to send a calendar-query request to the calendar located at the specified ResourceURI. The ReportFilter can be used to filter out and return only the calendar events you wish to receive. The response to a calendar-query report will be parsed by the class, and information about the individual events contained within shall be fired in the EventDetails event.

The following properties are used when creating a request with CreateEvent or ExportICS, and will be filled after calling GetEvent or ImportICS. These will also be available from inside the EventDetails event, which is fired for each event received from the CalDAV server in response to a GetCalendarReport.

• Alarms
• Attendees
• Categories
• Classification
• Completed
• Created
• CustomProperties
• Depth
• Description
• Duration
• EndDate
• EventType
• LastModified
• Location
• Organizer
• Priority
• Recurrence
• Sequence
• StartDate
• Status
• Summary
• Timestamp
• Timezone
• Transparency
• UID
• URL

For example: CalDAV.User = "myusername" CalDAV.Password = "mypassword" CalDAV.ReportFilterStartDate = "20090101T000000Z" CalDAV.ReportFilterEndDate = "20091231T230000Z" CalDAV.GetCalendarReport "https://caldav.calendar.yahoo.com/dav/username/Calendar/default_calendar/" The following code inside the EventDetails event will print the start and end time as well as the summary for each event: Private Sub CalDAV_EventDetails(ResourceURI As String, ResponseStatus As String, ETag As String, CalendarData As String, Summary As String) Debug.Print Summary & ": " & CalDAV.StartDate & " to " & CalDAV.EndDate End Sub The output from the above code will look something like this:

	Carolina Hurricanes vs. Colorado Avalanche: 20090222T150000 to 20090222T180000
	Lone Rider Brewery Tour: 20091107T124500 to 20091107T134500
	Salsa Dancing: 20090927T154500 to 20090927T181500
	Superbowl Party: 20090201T170000 to 20090202T000000
	Kathy's Birthday: 20090608T010000 to 20090608T020000
	Dinner at Shannon's: 20091001T183000 to 20091001T203000
	Carolina Rollergirls match: 20090411T170000 to 20090411T180000

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://apidata.googleusercontent.com/caldav/v2/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the CreateEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetEvent. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetEvent Method (CalDAV Class)

Retrieves a single event from the CalDAV server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEvent(const char* lpszResourceURI);

Unicode (Windows)
INT GetEvent(LPCWSTR lpszResourceURI);

int ipworks_caldav_getevent(void* lpObj, const char* lpszResourceURI);

int GetEvent(const QString& qsResourceURI);

Remarks

This method retrieves a single event from a CalDAV server. The ResourceURI points to the exact location of the iCal (*.ics) file you wish to retrieve. (If you do not know the URL of the event you need, you can use the GetCalendarReport method along with the ReportFilter property to find it.)

The event will be retrieved using the WebDAV GET method. The full response is delivered through the Transfer event and the HTTP response headers through the Header event. After an event is retrieved with this method, the class parses the calendar data into properties. You may then edit these properties and use CreateEvent to update the calendar event resource.

The following properties are used when creating a request with CreateEvent or ExportICS, and will be filled after calling GetEvent or ImportICS. These will also be available from inside the EventDetails event, which is fired for each event received from the CalDAV server in response to a GetCalendarReport.

• Alarms
• Attendees
• Categories
• Classification
• Completed
• Created
• CustomProperties
• Depth
• Description
• Duration
• EndDate
• EventType
• LastModified
• Location
• Organizer
• Priority
• Recurrence
• Sequence
• StartDate
• Status
• Summary
• Timestamp
• Timezone
• Transparency
• UID
• URL

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://apidata.googleusercontent.com/caldav/v2/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the CreateEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetEvent. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetFreeBusyReport Method (CalDAV Class)

Generates a report as to when the calendar owner is free and/or busy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFreeBusyReport(const char* lpszResourceURI);

Unicode (Windows)
INT GetFreeBusyReport(LPCWSTR lpszResourceURI);

int ipworks_caldav_getfreebusyreport(void* lpObj, const char* lpszResourceURI);

int GetFreeBusyReport(const QString& qsResourceURI);

Remarks

This method sends a free-busy-query request to the calendar at the specified ResourceURI. . The CalDAV server will return a list of FREEBUSY elements, which will be fired in the FreeBusy event and also stored in the FreeBusy collection. Each FREEBUSY element contains a type (BUSY, FREE, BUSY-TENTATIVE, etc.) and a date range.

Note that the StartDate field is required for a Free/Busy report. The EndDate field is optional. These are the only two ReportFilters used by the GetFreeBusyReport request, all other filters will be ignored.

Note that Google Calendar does not currently support Free/Busy reporting.

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://apidata.googleusercontent.com/caldav/v2/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the CreateEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetEvent. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ImportICS Method (CalDAV Class)

Imports calendar data (contained in an ICS file) into the class's property list.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportICS(const char* lpszCalendarData);

Unicode (Windows)
INT ImportICS(LPCWSTR lpszCalendarData);

int ipworks_caldav_importics(void* lpObj, const char* lpszCalendarData);

int ImportICS(const QString& qsCalendarData);

Remarks

This method is used to load calendar data from an external source into the class. You may then submit this data with a call to CreateEvent. If you edit any of the class properties between importing and calling CreateEvent, the class will re-generate the PUT request itself. If no properties are changed, the imported data will be submitted unaltered when calling CreateEvent.

As the calendar data is imported, the class will scan CalendarData for any calendar events. Each time a calendar event is discovered, the EventDetails event will fire, and the calendar event properties will be updated.

After ImportICS completes, the calendar event properties will be set to the most recent calendar event found in CalendarData.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (CalDAV Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworks_caldav_interrupt(void* lpObj);

int Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListCalendars Method (CalDAV Class)

Lists all calendars that the current user can access.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListCalendars(const char* lpszbaseURL);

Unicode (Windows)
INT ListCalendars(LPCWSTR lpszbaseURL);

int ipworks_caldav_listcalendars(void* lpObj, const char* lpszbaseURL);

int ListCalendars(const QString& qsbaseURL);

Remarks

This method lists all calendars the user can access.

The BaseURL parameter must be set to the base CalDAV URL for the server. For instance in the case of Google this is https://apidata.googleusercontent.com/caldav/v2. Other servers may use a format like https://mydavserver/.well-known/caldav/.

When this method is called the class will automatically perform a series of requests to obtain the calendar list. First, the class will send a PROPFIND request to the specified base URL to obtain the current-user-principle. Once the current user has been found, the class will then use that information to send a second PROPFIND request to get calendar-home-set for the user. The calendar-home-set is then be used by the class to make a final PROPFIND request to get the list of calendars for the user.

Once this method returns, the class will populate the Calendars collection. For example:

calDAV.ListCalendars("https://apidata.googleusercontent.com/caldav/v2"); for (int i = 0; i < calDAV.Calendars.Count; i++) { string url = calDAV.Calendars[i].URL; string displayName = calDAV.Calendars[i].DisplayName; ... }

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

LockCalendar Method (CalDAV Class)

Obtain a lock for a specified calendar resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LockCalendar(const char* lpszResourceURI);

Unicode (Windows)
INT LockCalendar(LPCWSTR lpszResourceURI);

int ipworks_caldav_lockcalendar(void* lpObj, const char* lpszResourceURI);

int LockCalendar(const QString& qsResourceURI);

Remarks

This method will request a new lock to be placed on ResourceURI in the user's name so that only the user can operate on it. The method is linked to a number of properties that it uses to generate the lock request:

This method is associated with the Depth property. If Depth is set to "0", the class will lock only ResourceURI and its properties. If Depth is set to "infinity", the class will lock ResourceURI and its entire subtree.

If MoveEvent or CopyEvent are used to place a resource or collection in a location under a resource locked with "infinity", the new resource or collection will be added to the lock. Any lock on a collection will prevent non-lock owners from adding resources to that collection.

Note that while the Yahoo CalDAV server does accept LockCalendar and UnLockCalendar requests, the server does not respect resource locks (either on events or on the entire calendar). The Google CalDAV sever does not support either of these requests, and will respond with an HTTP protocol error: 405 Method Not Allowed. Also, neither Yahoo nor Google CalDAV servers support copying or moving calendar resources.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

MoveEvent Method (CalDAV Class)

Moves one calendar resource to a new location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int MoveEvent(const char* lpszSourceResourceURI, const char* lpszDestinationResourceURI);

Unicode (Windows)
INT MoveEvent(LPCWSTR lpszSourceResourceURI, LPCWSTR lpszDestinationResourceURI);

int ipworks_caldav_moveevent(void* lpObj, const char* lpszSourceResourceURI, const char* lpszDestinationResourceURI);

int MoveEvent(const QString& qsSourceResourceURI, const QString& qsDestinationResourceURI);

Remarks

This method will move the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI.

This method is associated with the Depth property. If Depth is set to "0", the class will move only SourceResourceURI. If Depth is set to "infinity", the class will move SourceResourceURI and its entire subtree to locations relative to it.

If the user has acquired a lock of infinite depth (via LockCalendar) on either DestinationResourceURI or any collection it is under, SourceResourceURI will be added to that lock.

Note that neither Yahoo nor Google CalDAV servers support locking, copying, or moving calendar resources.

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://apidata.googleusercontent.com/caldav/v2/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the CreateEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetEvent. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (CalDAV Class)

Reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_caldav_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCustomRequest Method (CalDAV Class)

Sends a request to the CalDAV server to do CRUD operations.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCustomRequest(const char* lpszHttpMethod, const char* lpszUrl, const char* lpszRequestBody);

Unicode (Windows)
INT SendCustomRequest(LPCWSTR lpszHttpMethod, LPCWSTR lpszUrl, LPCWSTR lpszRequestBody);

int ipworks_caldav_sendcustomrequest(void* lpObj, const char* lpszHttpMethod, const char* lpszUrl, const char* lpszRequestBody);

int SendCustomRequest(const QString& qsHttpMethod, const QString& qsUrl, const QString& qsRequestBody);

Remarks

Allows users to send personalized HTTP commands to a CalDAV server. It requires three string parameters: HTTPMethod indicates the desired action (e.g., "GET," "POST"), url specifies the target resource's URL, and RequestBody includes data sent with the request. Here is an example of how to create a calendar event: string httpMethod = "MKCALENDAR"; string url = "https://caldav.calendar.yahoo.com/dav/user/Calendar/CreateCalendarTest"; string requestBody = "BEGIN:VCALENDAR PRODID:/n software IPWorks CalDAV Component - www.nsoftware.com VERSION:2.0 BEGIN:VEVENT UID: uidValue DTSTAMP: dtstampValue DTSTART: dtstartValue DTEND: dtendValue PRIORITY:0 SEQUENCE:0 SUMMARY:TEST END:VEVENT END:VCALENDAR" calDAV.SendCustomRequest(httpMethod, url, requestBody);

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UnLockCalendar Method (CalDAV Class)

Unlocks a calendar resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UnLockCalendar(const char* lpszResourceURI);

Unicode (Windows)
INT UnLockCalendar(LPCWSTR lpszResourceURI);

int ipworks_caldav_unlockcalendar(void* lpObj, const char* lpszResourceURI);

int UnLockCalendar(const QString& qsResourceURI);

Remarks

This method unlocks a calendar resource. Before calling UnLockCalendar on a particular calendar resource, the Token property must be set to the lock token for ResourceURI. The method will remove the lock, allowing other users or non-privileged users to access and operate on the file.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateCalendar Method (CalDAV Class)

Updates a calendar collection resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateCalendar(const char* lpszResourceURI, int iCalIndex);

Unicode (Windows)
INT UpdateCalendar(LPCWSTR lpszResourceURI, INT iCalIndex);

int ipworks_caldav_updatecalendar(void* lpObj, const char* lpszResourceURI, int iCalIndex);

int UpdateCalendar(const QString& qsResourceURI, int iCalIndex);

Remarks

This method updates an existing calendar collection at the specified ResourceURI. To successfully update a calendar, the ResourceURI should already exist, and must point to a valid location where a calendar is saved. This method requires the specified calendar collection index. Use ListCalendars and search through Calendars to find the index of the calendar to be updated.

The following example shows how to update a calendar collection resource: CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1", "test", "test"); calDAV.Calendars[0].DisplayName = "test_updated"; calDAV.Calendars[0].Color = "#000001"; calDAV.UpdateCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1", 0);

Note that Google does not support updating a calendar through CalDAV. It must be updated through the Google calendar web interface.

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://apidata.googleusercontent.com/caldav/v2/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the CreateEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetEvent. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateEvent Method (CalDAV Class)

Updates a calendar resource at the specified ResourceURI using the CalDAV PUT method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateEvent(const char* lpszResourceURI);

Unicode (Windows)
INT UpdateEvent(LPCWSTR lpszResourceURI);

int ipworks_caldav_updateevent(void* lpObj, const char* lpszResourceURI);

int UpdateEvent(const QString& qsResourceURI);

Remarks

This method updates an existing event to the calendar collection at the specified ResourceURI. The ResourceURI must be a fully qualified URL to the location on the CalDAV server to which this event is saved.

NOTE: Some CalDAV servers (Yahoo for example) require that the UID and the filename portion of the URI match. For example, if the UID is "hello_world" then the ResourceURI parameter of the UpdateEvent should be "https://caldav.calendar.yahoo.com/dav/user_name/Calendar/My_Calendar/hello_world.ics". If the UID and filename portion of the URI do not match, the Yahoo CalDAV server will return a "302 Found" response indicating that the requested resource resides under a different URI. (Meaning the event was not added to the calendar). NextCloud on the other hand doesn't have this requirement.

The following properties are used when creating a request with CreateEvent or ExportICS, and will be filled after calling GetEvent or ImportICS. These will also be available from inside the EventDetails event, which is fired for each event received from the CalDAV server in response to a GetCalendarReport.

• Alarms
• Attendees
• Categories
• Classification
• Completed
• Created
• CustomProperties
• Depth
• Description
• Duration
• EndDate
• EventType
• LastModified
• Location
• Organizer
• Priority
• Recurrence
• Sequence
• StartDate
• Status
• Summary
• Timestamp
• Timezone
• Transparency
• UID
• URL

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://apidata.googleusercontent.com/caldav/v2/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the CreateEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetEvent. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (CalDAV Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(CalDAVConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} CalDAVConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(CalDAVConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} CalDAVConnectedEventParams;

#define EID_CALDAV_CONNECTED 1

virtual INT IPWORKS_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class CalDAVConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(CalDAVConnectedEventParams *e);

// Or, subclass CalDAV and override this emitter function.
virtual int FireConnected(CalDAVConnectedEventParams *e) {...}

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (CalDAV Class)

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(CalDAVConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} CalDAVConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(CalDAVConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} CalDAVConnectionStatusEventParams;

#define EID_CALDAV_CONNECTIONSTATUS 2

virtual INT IPWORKS_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class CalDAVConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(CalDAVConnectionStatusEventParams *e);

// Or, subclass CalDAV and override this emitter function.
virtual int FireConnectionStatus(CalDAVConnectionStatusEventParams *e) {...}

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (CalDAV Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(CalDAVDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} CalDAVDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(CalDAVDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} CalDAVDisconnectedEventParams;

#define EID_CALDAV_DISCONNECTED 3

virtual INT IPWORKS_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class CalDAVDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(CalDAVDisconnectedEventParams *e);

// Or, subclass CalDAV and override this emitter function.
virtual int FireDisconnected(CalDAVDisconnectedEventParams *e) {...}

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (CalDAV Class)

This event is fired when a document finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(CalDAVEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} CalDAVEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(CalDAVEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} CalDAVEndTransferEventParams;

#define EID_CALDAV_ENDTRANSFER 4

virtual INT IPWORKS_CALL FireEndTransfer(INT &iDirection);

class CalDAVEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(CalDAVEndTransferEventParams *e);

// Or, subclass CalDAV and override this emitter function.
virtual int FireEndTransfer(CalDAVEndTransferEventParams *e) {...}

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (CalDAV Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(CalDAVErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} CalDAVErrorEventParams;


Unicode (Windows)
virtual INT FireError(CalDAVErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} CalDAVErrorEventParams;

#define EID_CALDAV_ERROR 5

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class CalDAVErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(CalDAVErrorEventParams *e);

// Or, subclass CalDAV and override this emitter function.
virtual int FireError(CalDAVErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

EventDetails Event (CalDAV Class)

Fires for each calendar event received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEventDetails(CalDAVEventDetailsEventParams *e);

typedef struct {
  const char *ResourceURI;
  const char *ResponseStatus;
  const char *ETag;
  const char *CalendarData;
  const char *Summary;
  int reserved;
} CalDAVEventDetailsEventParams;


Unicode (Windows)
virtual INT FireEventDetails(CalDAVEventDetailsEventParams *e);

typedef struct {
  LPCWSTR ResourceURI;
  LPCWSTR ResponseStatus;
  LPCWSTR ETag;
  LPCWSTR CalendarData;
  LPCWSTR Summary;
  INT reserved;
} CalDAVEventDetailsEventParams;

#define EID_CALDAV_EVENTDETAILS 6

virtual INT IPWORKS_CALL FireEventDetails(LPSTR &lpszResourceURI, LPSTR &lpszResponseStatus, LPSTR &lpszETag, LPSTR &lpszCalendarData, LPSTR &lpszSummary);

class CalDAVEventDetailsEventParams {
public:
  const QString &ResourceURI();

  const QString &ResponseStatus();

  const QString &ETag();

  const QString &CalendarData();

  const QString &Summary();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EventDetails(CalDAVEventDetailsEventParams *e);

// Or, subclass CalDAV and override this emitter function.
virtual int FireEventDetails(CalDAVEventDetailsEventParams *e) {...}

Remarks

This event fires for each VEVENT, VTODO, VJOURNAL, or VFREEBUSY event received in response to a GetCalendarReport request. The ResourceURI parameter indicates the location of this particular event on the CalDAV server, and the ETag parameter is used to indicate the current state of the calendar event. If the ETag is different from the value you have cached for the current ResourceURI, it means the event has changed on the server since the last time you updated your cache. ResponseStatus indicates the HTTP status of CalDAV server received when attempting to retrieve this particular ResourceURI when it was building the report. The CalendarData parameter contains the raw calendar entry as returned by the CalDAV server. This data is also parsed into the following properties, and are valid for the current ResourceURI only inside this event. The Summary parameter indicates the summary of this particular calendar event.

• Alarms
• Attendees
• Categories
• Classification
• Completed
• Created
• CustomProperties
• Depth
• Description
• Duration
• EndDate
• RelatedTo
• EventType
• LastModified
• Location
• Organizer
• Priority
• Recurrence
• Sequence
• StartDate
• Status
• Summary
• Timestamp
• Timezone
• Transparency
• UID
• URL

Note that for a large calendar you may not wish to return the full contents of each calendar event, as this could be a substantially large amount of data. In this case, set the ReturnCalendarData field to false, and only the ResourceURI, ResponseStatus, and ETag parameters will be returned by the CalDAV server for each calendar event. The contents of the event will not be returned, and the CalendarData parameter will be empty.

*The ResourceURI and the URL property are not the same. The URL property is an iCal field, and the ResourceURI is the actual location of the resource on the CalDAV server. Some CalDAV servers may force the URL to match the ResourceURI, but the URL should be treated as a separate user-defined entity by the user, and it should not be expected to match the ResourceURI. Likewise, ResponseStatus and Status are not the same. Status is the status of the event (TENTATIVE, CONFIRMED, CANCELLED, etc). ResponseStatus is the HTTP status received when the CalDAV server attempted to retrieve the current event when constructing a report.

FreeBusy Event (CalDAV Class)

Fires for each Free/Busy element received in the response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireFreeBusy(CalDAVFreeBusyEventParams *e);

typedef struct {
  const char *BusyType;
  const char *BusyRange;
  int reserved;
} CalDAVFreeBusyEventParams;


Unicode (Windows)
virtual INT FireFreeBusy(CalDAVFreeBusyEventParams *e);

typedef struct {
  LPCWSTR BusyType;
  LPCWSTR BusyRange;
  INT reserved;
} CalDAVFreeBusyEventParams;

#define EID_CALDAV_FREEBUSY 7

virtual INT IPWORKS_CALL FireFreeBusy(LPSTR &lpszBusyType, LPSTR &lpszBusyRange);

class CalDAVFreeBusyEventParams {
public:
  const QString &BusyType();

  const QString &BusyRange();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FreeBusy(CalDAVFreeBusyEventParams *e);

// Or, subclass CalDAV and override this emitter function.
virtual int FireFreeBusy(CalDAVFreeBusyEventParams *e) {...}

Remarks

This event fires for each FREEBUSY element received in response to a GetFreeBusyReport request. The FBTYPE will be contained in the BusyType parameter, and the FREEBUSY value itself will be contained in the BusyRange parameter. The Free/Busy information will also be stored in the FreeBusy collection.

Header Event (CalDAV Class)

Fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(CalDAVHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} CalDAVHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(CalDAVHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} CalDAVHeaderEventParams;

#define EID_CALDAV_HEADER 8

virtual INT IPWORKS_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class CalDAVHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(CalDAVHeaderEventParams *e);

// Or, subclass CalDAV and override this emitter function.
virtual int FireHeader(CalDAVHeaderEventParams *e) {...}

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (CalDAV Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(CalDAVLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} CalDAVLogEventParams;


Unicode (Windows)
virtual INT FireLog(CalDAVLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} CalDAVLogEventParams;

#define EID_CALDAV_LOG 9

virtual INT IPWORKS_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class CalDAVLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(CalDAVLogEventParams *e);

// Or, subclass CalDAV and override this emitter function.
virtual int FireLog(CalDAVLogEventParams *e) {...}

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

Redirect Event (CalDAV Class)

Fired when a redirection is received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRedirect(CalDAVRedirectEventParams *e);

typedef struct {
  const char *Location;
  int Accept;
  int reserved;
} CalDAVRedirectEventParams;


Unicode (Windows)
virtual INT FireRedirect(CalDAVRedirectEventParams *e);

typedef struct {
  LPCWSTR Location;
  BOOL Accept;
  INT reserved;
} CalDAVRedirectEventParams;

#define EID_CALDAV_REDIRECT 10

virtual INT IPWORKS_CALL FireRedirect(LPSTR &lpszLocation, BOOL &bAccept);

class CalDAVRedirectEventParams {
public:
  const QString &Location();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Redirect(CalDAVRedirectEventParams *e);

// Or, subclass CalDAV and override this emitter function.
virtual int FireRedirect(CalDAVRedirectEventParams *e) {...}

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (CalDAV Class)

Fired for every cookie set by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSetCookie(CalDAVSetCookieEventParams *e);

typedef struct {
  const char *Name;
  const char *Value;
  const char *Expires;
  const char *Domain;
  const char *Path;
  int Secure;
  int reserved;
} CalDAVSetCookieEventParams;


Unicode (Windows)
virtual INT FireSetCookie(CalDAVSetCookieEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Value;
  LPCWSTR Expires;
  LPCWSTR Domain;
  LPCWSTR Path;
  BOOL Secure;
  INT reserved;
} CalDAVSetCookieEventParams;

#define EID_CALDAV_SETCOOKIE 11

virtual INT IPWORKS_CALL FireSetCookie(LPSTR &lpszName, LPSTR &lpszValue, LPSTR &lpszExpires, LPSTR &lpszDomain, LPSTR &lpszPath, BOOL &bSecure);

class CalDAVSetCookieEventParams {
public:
  const QString &Name();

  const QString &Value();

  const QString &Expires();

  const QString &Domain();

  const QString &Path();

  bool Secure();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SetCookie(CalDAVSetCookieEventParams *e);

// Or, subclass CalDAV and override this emitter function.
virtual int FireSetCookie(CalDAVSetCookieEventParams *e) {...}

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (CalDAV Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(CalDAVSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} CalDAVSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(CalDAVSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} CalDAVSSLServerAuthenticationEventParams;