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 calendaring and scheduling information based on the iCalendar format.

Syntax

CalDAV

Remarks

The CalDAV Class supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

The class allows remote management of calendar events and collections of events (the calendar itself), including creation, deletion, listing, copying, and moving. 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 PutCalendarEvent method, and can be retrieved via the GetCalendarEvent method. Events may be copied or moved with the CopyCalendarEvent and MoveCalendarEvent.

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return a HTTP 403 Forbidden response.

The following properties are used when creating a request with PutCalendarEvent or ExportICS, and will be filled after calling GetCalendarEvent 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
• DisplayName
• 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:

• CopyCalendarEvent
• DeleteCalendarEvent
• MoveCalendarEvent
• GetCalendarEvent
• PutCalendarEvent

• CreateCalendar
• GetCalendarOptions
• GetCalendarReport
• GetFreeBusyReport

There is no standard format for resource URIs. Google for instance, uses "https://www.google.com/calendar/dav/" plus your email address to access the default calendar. So "https://www.google.com/calendar/dav/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://www.google.com/calendar/dav/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://www.google.com/calendar/dav/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 PutCalendarEvent 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 GetCalendarEvent. For example: CalDAV.UID = "1234567890"; CalDAV.PutCalendarEvent("https://www.google.com/calendar/dav/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: CalDAVS1.User = "username"; CalDAVS1.Password = "password"; CalDAV.DisplayName = "My Hockey Calendar"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/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.PutCalendarEvent("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.

AlarmCount Property (CalDAV Class)

The number of records in the Alarm arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAlarmCount();
int SetAlarmCount(int iAlarmCount);

Unicode (Windows)
INT GetAlarmCount();
INT SetAlarmCount(INT iAlarmCount);

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

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• AlarmAction
• AlarmAttachment
• AlarmAttachmentType
• AlarmDuration
• AlarmMessage
• AlarmRecipient
• AlarmRepeat
• AlarmSubject
• AlarmTrigger

The array indices start at 0 and end at AlarmCount - 1.

This property is not available at design time.

Data Type

Integer

AlarmAction Property (CalDAV Class)

This property determines what the CalDAV server will do when the alarm Trigger is reached.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAlarmAction(int iAlarmIndex);
int SetAlarmAction(int iAlarmIndex, int iAlarmAction);

Unicode (Windows)
INT GetAlarmAction(INT iAlarmIndex);
INT SetAlarmAction(INT iAlarmIndex, INT iAlarmAction);

A_NO_ALARM(0), 
A_AUDIO(1), 
A_DISPLAY(2), 
A_EMAIL(3)

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

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

Default Value

0

Remarks

This property determines what the CalDAV server will do when the alarm AlarmTrigger is reached. The following table explains the possible alarm actions:

The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

Integer

AlarmAttachment Property (CalDAV Class)

This property contains a sound file attached to the alarm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAlarmAttachment(int iAlarmIndex);
int SetAlarmAttachment(int iAlarmIndex, const char* lpszAlarmAttachment);

Unicode (Windows)
LPWSTR GetAlarmAttachment(INT iAlarmIndex);
INT SetAlarmAttachment(INT iAlarmIndex, LPCWSTR lpszAlarmAttachment);

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

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

Default Value

""

Remarks

This property contains a sound file attached to the alarm. If the AlarmAction is set to aAudio, this property may optionally contain a base-64 encoded binary sound file to be played. The AlarmAttachmentType property indicates the data type of the attached file.

The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

String

AlarmAttachmentType Property (CalDAV Class)

This property contains the MIME-Type of the attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAlarmAttachmentType(int iAlarmIndex);
int SetAlarmAttachmentType(int iAlarmIndex, const char* lpszAlarmAttachmentType);

Unicode (Windows)
LPWSTR GetAlarmAttachmentType(INT iAlarmIndex);
INT SetAlarmAttachmentType(INT iAlarmIndex, LPCWSTR lpszAlarmAttachmentType);

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

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

Default Value

""

Remarks

This property contains the MIME-Type of the attachment. If the AlarmAction is set to aAudio or aEmail the AlarmAttachment property may optionally contain a base-64 binary encoded attachment. The AlarmAttachmentType property is used to tell the CalDAV server what type of binary file it is receiving. This property is a standard MIME content type, in the format "type/sub-type". The most common audio types are shown in the table below:

You may use standard MIME content-types for any other file type you wish to submit in the AlarmAttachment property. If AlarmAttachment is specified but AlarmAttachmentType is left blank, no format type will be submitted with the AlarmAttachment and the CalDAV server may (or may not) attempt to determine the data type itself.

The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

String

AlarmDuration Property (CalDAV Class)

This property contains the interval between repeating alarms.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAlarmDuration(int iAlarmIndex);
int SetAlarmDuration(int iAlarmIndex, const char* lpszAlarmDuration);

Unicode (Windows)
LPWSTR GetAlarmDuration(INT iAlarmIndex);
INT SetAlarmDuration(INT iAlarmIndex, LPCWSTR lpszAlarmDuration);

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

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

Default Value

""

Remarks

This property contains the interval between repeating alarms. This property is only used when an alarm is set to AlarmRepeat multiple times. It is specified in the form of a Duration data type. 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.

The following is an example of an alarm that repeats 4 additional times after the initial AlarmTrigger, with a 5-minute delay between each alarm: CalDav.Trigger = "-PT10M"; CalDAV.Alarm.Repeat = 4; CalDAV.Duration = "PT5M" CalDAV.Action = aDisplay;

If AlarmDuration is specified, AlarmRepeat MUST also be specified.

The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

String

AlarmMessage Property (CalDAV Class)

This property contains a message used to alert the user when this alarm is triggered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAlarmMessage(int iAlarmIndex);
int SetAlarmMessage(int iAlarmIndex, const char* lpszAlarmMessage);

Unicode (Windows)
LPWSTR GetAlarmMessage(INT iAlarmIndex);
INT SetAlarmMessage(INT iAlarmIndex, LPCWSTR lpszAlarmMessage);

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

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

Default Value

""

Remarks

This property contains a message used to alert the user when this alarm is triggered. If the AlarmAction is set to aDisplay, this property must contain the message that is to be displayed to the user. If AlarmAction is set to aEmail this property will contain the message body of the email that is sent to the AlarmRecipient. For instance: CalDAV.Alarm.Action = aEmail; CalDAV.Alarm.Recipient = "mailto:john_doe@example.com"; CalDAV.Alarm.Message = "A draft agenda needs to be sent out to the attendees to the weekly managers meeting (MGR-LIST)."; CalDAV.Alarm.Subject = "REMINDER: Send agenda for weekly staff meeting."; or CalDAV.Alarm.Action = aDisplay; CalDAV.Alarm.Message = "REMINDER: Send agenda for weekly staff meeting."; AlarmMessage is not used for the aAudio alarm AlarmAction.

The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

String

AlarmRecipient Property (CalDAV Class)

This property contains the email address of the person to be alerted when this alarm is triggered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAlarmRecipient(int iAlarmIndex);
int SetAlarmRecipient(int iAlarmIndex, const char* lpszAlarmRecipient);

Unicode (Windows)
LPWSTR GetAlarmRecipient(INT iAlarmIndex);
INT SetAlarmRecipient(INT iAlarmIndex, LPCWSTR lpszAlarmRecipient);

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

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

Default Value

""

Remarks

This property contains the email address of the person to be alerted when this alarm is triggered. If AlarmAction is set to aEmail this property must contain one or more comma-separated email addresses to which the email alarm is to be sent. For instance: CalDAV.Alarm.Action = aEmail; CalDAV.Alarm.Recipient = "mailto:john_doe@example.com"; CalDAV.Alarm.Message = "A draft agenda needs to be sent out to the attendees to the weekly managers meeting (MGR-LIST)."; CalDAV.Alarm.Subject = "REMINDER: Send agenda for weekly staff meeting."; AlarmRecipient is not used for the aAudio or aDisplay alarm AlarmActions.

The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

String

AlarmRepeat Property (CalDAV Class)

This property contains the number of times the alarm is to be repeated after the initial trigger.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAlarmRepeat(int iAlarmIndex);
int SetAlarmRepeat(int iAlarmIndex, int iAlarmRepeat);

Unicode (Windows)
INT GetAlarmRepeat(INT iAlarmIndex);
INT SetAlarmRepeat(INT iAlarmIndex, INT iAlarmRepeat);

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

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

Default Value

0

Remarks

This property contains the number of times the alarm is to be repeated after the initial trigger.

This property defines the number of times an alarm should be repeated after its initial AlarmTrigger. If the alarm triggers more than once, then this property MUST be specified along with the AlarmDuration property.

The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

Integer

AlarmSubject Property (CalDAV Class)

This property contains the subject of the message used to alert the user when this alarm is triggered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAlarmSubject(int iAlarmIndex);
int SetAlarmSubject(int iAlarmIndex, const char* lpszAlarmSubject);

Unicode (Windows)
LPWSTR GetAlarmSubject(INT iAlarmIndex);
INT SetAlarmSubject(INT iAlarmIndex, LPCWSTR lpszAlarmSubject);

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

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

Default Value

""

Remarks

This property contains the subject of the message used to alert the user when this alarm is triggered. If AlarmAction is set to aEmail this property will contain the subject the email that is sent to the AlarmRecipient. For instance: CalDAV.Alarm.Action = aEmail; CalDAV.Alarm.Recipient = "mailto:john_doe@example.com"; CalDAV.Alarm.Message = "A draft agenda needs to be sent out to the attendees to the weekly managers meeting (MGR-LIST)."; CalDAV.Alarm.Subject = "REMINDER: Send agenda for weekly staff meeting."; AlarmSubject is not used for the aAudio or aDisplay alarm AlarmActions.

The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

String

AlarmTrigger Property (CalDAV Class)

This property contains the time when the alarm is triggered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAlarmTrigger(int iAlarmIndex);
int SetAlarmTrigger(int iAlarmIndex, const char* lpszAlarmTrigger);

Unicode (Windows)
LPWSTR GetAlarmTrigger(INT iAlarmIndex);
INT SetAlarmTrigger(INT iAlarmIndex, LPCWSTR lpszAlarmTrigger);

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

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

Default Value

""

Remarks

This property contains the time when the alarm is triggered.

The AlarmTrigger is represented as a duration relative to the start of an event. The format is (+/-)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:

The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

String

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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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)

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

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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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)

This shows whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected);

Unicode (Windows)
BOOL GetConnected();
INT SetConnected(BOOL bConnected);

int ipworks_caldav_getconnected(void* lpObj);
int ipworks_caldav_setconnected(void* lpObj, int bConnected);

bool GetConnected();
int SetConnected(bool bConnected);

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

CookieCount Property (CalDAV Class)

The number of records in the Cookie arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCookieCount();
int SetCookieCount(int iCookieCount);

Unicode (Windows)
INT GetCookieCount();
INT SetCookieCount(INT iCookieCount);

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

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• CookieDomain
• CookieExpiration
• CookieName
• CookiePath
• CookieSecure
• CookieValue

The array indices start at 0 and end at CookieCount - 1.

This property is not available at design time.

Data Type

Integer

CookieDomain Property (CalDAV Class)

This is the domain of a received cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieDomain(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookieDomain(INT iCookieIndex);

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

QString GetCookieDomain(int iCookieIndex);

Default Value

""

Remarks

This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieExpiration Property (CalDAV Class)

This property contains an expiration time for the cookie (if provided by the server).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieExpiration(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookieExpiration(INT iCookieIndex);

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

QString GetCookieExpiration(int iCookieIndex);

Default Value

""

Remarks

This property 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, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieName Property (CalDAV Class)

This property, contains the name of the cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, const char* lpszCookieName);

Unicode (Windows)
LPWSTR GetCookieName(INT iCookieIndex);
INT SetCookieName(INT iCookieIndex, LPCWSTR lpszCookieName);

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

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

Default Value

""

Remarks

This property, contains the name of the cookie.

This property, along with CookieValue, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

CookiePath Property (CalDAV Class)

This property contains a path name to limit the cookie to (if provided by the server).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookiePath(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookiePath(INT iCookieIndex);

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

QString GetCookiePath(int iCookieIndex);

Default Value

""

Remarks

This property 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 property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieSecure Property (CalDAV Class)

This property contains the security flag of the received cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCookieSecure(int iCookieIndex);

Unicode (Windows)
BOOL GetCookieSecure(INT iCookieIndex);

int ipworks_caldav_getcookiesecure(void* lpObj, int cookieindex);

bool GetCookieSecure(int iCookieIndex);

Default Value

FALSE

Remarks

This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

Boolean

CookieValue Property (CalDAV Class)

This property contains the value of the cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, const char* lpszCookieValue);

Unicode (Windows)
LPWSTR GetCookieValue(INT iCookieIndex);
INT SetCookieValue(INT iCookieIndex, LPCWSTR lpszCookieValue);

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

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

Default Value

""

Remarks

This property contains the value of the cookie. A corresponding value is associated with the cookie specified by CookieName. This property holds that value.

The SetCookie event provides the cookies set by the server.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

Created Property (CalDAV Class)

Date and time calendar information created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCreated();
int SetCreated(const char* lpszCreated);

Unicode (Windows)
LPWSTR GetCreated();
INT SetCreated(LPCWSTR lpszCreated);

char* ipworks_caldav_getcreated(void* lpObj);
int ipworks_caldav_setcreated(void* lpObj, const char* lpszCreated);

QString GetCreated();
int SetCreated(QString qsCreated);

Default Value

""

Remarks

This property specifies the date and time that the calendar information was created by the calendar user agent in the calendar store. 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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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

CustomPropertyCount Property (CalDAV Class)

The number of records in the CustomProperty arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCustomPropertyCount();
int SetCustomPropertyCount(int iCustomPropertyCount);

Unicode (Windows)
INT GetCustomPropertyCount();
INT SetCustomPropertyCount(INT iCustomPropertyCount);

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

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• CustomPropertyAttribute
• CustomPropertyName
• CustomPropertyValue

The array indices start at 0 and end at CustomPropertyCount - 1.

This property is not available at design time.

Data Type

Integer

CustomPropertyAttribute Property (CalDAV Class)

This property contains an optional attribute of the custom property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomPropertyAttribute(int iCustomPropertyIndex);
int SetCustomPropertyAttribute(int iCustomPropertyIndex, const char* lpszCustomPropertyAttribute);

Unicode (Windows)
LPWSTR GetCustomPropertyAttribute(INT iCustomPropertyIndex);
INT SetCustomPropertyAttribute(INT iCustomPropertyIndex, LPCWSTR lpszCustomPropertyAttribute);

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

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

Default Value

""

Remarks

This property contains an optional attribute of the custom property.

The CustomPropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomPropertyCount property.

This property is not available at design time.

Data Type

String

CustomPropertyName Property (CalDAV Class)

This property contains the textual name of the custom property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomPropertyName(int iCustomPropertyIndex);
int SetCustomPropertyName(int iCustomPropertyIndex, const char* lpszCustomPropertyName);

Unicode (Windows)
LPWSTR GetCustomPropertyName(INT iCustomPropertyIndex);
INT SetCustomPropertyName(INT iCustomPropertyIndex, LPCWSTR lpszCustomPropertyName);

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

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

Default Value

""

Remarks

This property contains the textual name of the custom property.

The CustomPropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomPropertyCount property.

This property is not available at design time.

Data Type

String

CustomPropertyValue Property (CalDAV Class)

This property contains the value of the custom property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomPropertyValue(int iCustomPropertyIndex);
int SetCustomPropertyValue(int iCustomPropertyIndex, const char* lpszCustomPropertyValue);

Unicode (Windows)
LPWSTR GetCustomPropertyValue(INT iCustomPropertyIndex);
INT SetCustomPropertyValue(INT iCustomPropertyIndex, LPCWSTR lpszCustomPropertyValue);

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

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

Default Value

""

Remarks

This property contains the value of the custom property.

The CustomPropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomPropertyCount property.

This property is not available at design time.

Data Type

String

Depth Property (CalDAV Class)

The depth associated with the current operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDepth();
int SetDepth(int iDepth);

Unicode (Windows)
INT GetDepth();
INT SetDepth(INT iDepth);

DP_UNSPECIFIED(0), 
DP_RESOURCE_ONLY(1), 
DP_IMMEDIATE_CHILDREN(2), 
DP_INFINITY(3)

int ipworks_caldav_getdepth(void* lpObj);
int ipworks_caldav_setdepth(void* lpObj, int iDepth);

int GetDepth();
int SetDepth(int iDepth);

Default Value

0

Remarks

This property defines how deep to operate within a collection. When performing certain operations on resource collections, the class will use Depth to instruct the server on how deep to operate within the collection. Depth is an enumerated type with the following possible values:

Depth is used when performing the following operations: LockCalendar, MoveCalendarEvent, CopyCalendarEvent, and GetCalendarReport

Data Type

Integer

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. It is also used by the CreateCalendar method when creating a new calendar collection.

Data Type

String

DisplayName Property (CalDAV Class)

Provides the display name of the calendar being created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDisplayName();
int SetDisplayName(const char* lpszDisplayName);

Unicode (Windows)
LPWSTR GetDisplayName();
INT SetDisplayName(LPCWSTR lpszDisplayName);

char* ipworks_caldav_getdisplayname(void* lpObj);
int ipworks_caldav_setdisplayname(void* lpObj, const char* lpszDisplayName);

QString GetDisplayName();
int SetDisplayName(QString qsDisplayName);

Default Value

""

Remarks

This property provides the name to be displayed for a calendar. This may or may not be defined on any calendar collection. It should be set before creating a new calendar collection via the CreateCalendar method.

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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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 PutCalendarEvent 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 ReportFilterReturnCalendarData property 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 PutCalendarEvent 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.PutCalendarEvent "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 GetCalendarEvent and update the most recent version.

This property is filled from the response to a GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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

FirewallAutoDetect Property (CalDAV Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

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

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

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (CalDAV Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

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

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

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CalDAV Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

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

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

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (CalDAV Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

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

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

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (CalDAV Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

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

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

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (CalDAV Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

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

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

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FollowRedirects Property (CalDAV Class)

This property 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

FreeBusyCount Property (CalDAV Class)

The number of records in the FreeBusy arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFreeBusyCount();

Unicode (Windows)
INT GetFreeBusyCount();

int ipworks_caldav_getfreebusycount(void* lpObj);

int GetFreeBusyCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• FreeBusyRange
• FreeBusyType

The array indices start at 0 and end at FreeBusyCount - 1.

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

Data Type

Integer

FreeBusyRange Property (CalDAV Class)

Contains the date/time range when the calendar owner is busy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFreeBusyRange(int iFreeBusyIndex);

Unicode (Windows)
LPWSTR GetFreeBusyRange(INT iFreeBusyIndex);

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

QString GetFreeBusyRange(int iFreeBusyIndex);

Default Value

""

Remarks

Contains the date/time range when the calendar owner is busy. The format for this property is either "DATETIME/DATETIME" or "DATETIME/DURATION"

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.

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.

The FreeBusyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FreeBusyCount property.

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

Data Type

String

FreeBusyType Property (CalDAV Class)

Indicates the busy status of the corresponding BusyRange .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFreeBusyType(int iFreeBusyIndex);

Unicode (Windows)
LPWSTR GetFreeBusyType(INT iFreeBusyIndex);

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

QString GetFreeBusyType(int iFreeBusyIndex);

Default Value

""

Remarks

Indicates the busy status of the corresponding FreeBusyBusyRange. A calendar may use custom values for the FreeBusyBusyType, but the standard values include:

• BUSY
• FREE
• BUSY-TENTATIVE
• BUSY-UNAVAILABLE

The FreeBusyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FreeBusyCount property.

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

Data Type

String

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

Idle will be False if the component is currently busy (communicating and/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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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 multi-homed 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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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

LockType Property (CalDAV Class)

The type of the current resource lock.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLockType();
int SetLockType(const char* lpszLockType);

Unicode (Windows)
LPWSTR GetLockType();
INT SetLockType(LPCWSTR lpszLockType);

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

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

Default Value

"write"

Remarks

The type of the current resource lock.

Before the calendar resource can be locked, the LockType may be set to the type of lock being requested. Currently, the class only supports requesting locks of type "write", although the protocol defines an optional "read" lock. After a successful LockCalendar operation, the class will set the LockType property to the correct value returned in the server's response.

Data Type

String

LockOwner Property (CalDAV Class)

The principle that owns the current resource lock.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLockOwner();
int SetLockOwner(const char* lpszLockOwner);

Unicode (Windows)
LPWSTR GetLockOwner();
INT SetLockOwner(LPCWSTR lpszLockOwner);

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

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

Default Value

""

Remarks

The principle that owns the current resource lock.

Before the calendar resource can be locked, the Lock LockOwner may be set to the name of a principle or group of principles that will own the lock. If no owner is specified, the server will automatically associate the lock with the requesting principle. After a successful LockCalendar operation, the class will set the LockOwner property to the correct value returned in the server's response.

Data Type

String

LockScope Property (CalDAV Class)

The scope of the current resource lock.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLockScope();
int SetLockScope(const char* lpszLockScope);

Unicode (Windows)
LPWSTR GetLockScope();
INT SetLockScope(LPCWSTR lpszLockScope);

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

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

Default Value

""

Remarks

The scope of the current resource lock.

Before the calendar resource can be locked, the Lock LockScope may be set to the type of scope needed for the lock. Currently the class will only allow two types of scopes to be requested:

If no scope is specified, the protocol default scope, "exclusive", will be requested. After a successful LockCalendar operation, the class will set the LockScope property to the correct value returned in the server's response.

Data Type

String

LockTimeout Property (CalDAV Class)

The time to live for the current resource lock.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLockTimeout();
int SetLockTimeout(int iLockTimeout);

Unicode (Windows)
INT GetLockTimeout();
INT SetLockTimeout(INT iLockTimeout);

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

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

Default Value

0

Remarks

The time to live for the current resource lock.

Before the calendar resource can be locked, the Lock LockTimeout may be set to a specific amount of time needed for the locked operation to take place. The timeout is used to determine how long the lock may exist before the server automatically unlocks the resource URI. If LockTimeout of 0 is specified, the server will use a default timeout. After a successful LockCalendar operation, the class will set the Lock LockTimeout property to the correct value returned in the server's response.

Data Type

Integer

LockTokens Property (CalDAV Class)

The lock string to be used when submitting operations on a locked resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLockTokens();
int SetLockTokens(const char* lpszLockTokens);

Unicode (Windows)
LPWSTR GetLockTokens();
INT SetLockTokens(LPCWSTR lpszLockTokens);

char* ipworks_caldav_getlocktokens(void* lpObj);
int ipworks_caldav_setlocktokens(void* lpObj, const char* lpszLockTokens);

QString GetLockTokens();
int SetLockTokens(QString qsLockTokens);

Default Value

""

Remarks

The lock string to be used when submitting operations on a locked resource.

Before the calendar resource can be locked, the Lock LockTokens may be set to the tokens returned by a previous lock operation. This is useful when renewing a timeout. The server will respond with a new timeout value, which will be stored in LockTimeout. If the lock request is not a lock refresh, LockTokens must be empty, and will be parsed out of the server response after a successful LockCalendar operation.

Data Type

String

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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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)

This property includes 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 PutCalendarEvent or retrieving an event with GetCalendarEvent, 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 PutCalendarEvent 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

ParsedHeaderCount Property (CalDAV Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int ipworks_caldav_getparsedheadercount(void* lpObj);

int GetParsedHeaderCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

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

Data Type

Integer

ParsedHeaderField Property (CalDAV Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderField(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);

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

QString GetParsedHeaderField(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

ParsedHeaderValue Property (CalDAV Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderValue(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);

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

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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

ProxyAuthScheme Property (CalDAV Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

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

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

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

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (CalDAV Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

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

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

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (CalDAV Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

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

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

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (CalDAV Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

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

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

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (CalDAV Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

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

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

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (CalDAV Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

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

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

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (CalDAV Class)

This property contains a username if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

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

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

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RecurrenceDates Property (CalDAV Class)

Individual dates on which the event will recur.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecurrenceDates();
int SetRecurrenceDates(const char* lpszRecurrenceDates);

Unicode (Windows)
LPWSTR GetRecurrenceDates();
INT SetRecurrenceDates(LPCWSTR lpszRecurrenceDates);

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

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

Default Value

""

Remarks

Individual dates on which the event will recur.

This property is used if you wish to denote specific, individual dates on which the event recurs. If you have an event that occurs monthly or weekly or on some other time interval, use the RecurrenceRule property instead.

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the CalDAV EventDetails event.

Data Type

String

RecurrenceExceptionDates Property (CalDAV Class)

Defines the list of DATE-TIME exceptions to the recurrence set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecurrenceExceptionDates();
int SetRecurrenceExceptionDates(const char* lpszRecurrenceExceptionDates);

Unicode (Windows)
LPWSTR GetRecurrenceExceptionDates();
INT SetRecurrenceExceptionDates(LPCWSTR lpszRecurrenceExceptionDates);

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

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

Default Value

""

Remarks

Defines the list of DATE-TIME exceptions to the recurrence set.

If the RecurrenceExceptionDates and RecurrenceExceptionRule are specified, they are used in computing the recurrence set. 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 RecurrenceRule, RecurrenceDates, RecurrenceExceptionRule, and RecurrenceExceptionDates properties 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 RecurrenceRule and RecurrenceDates properties, and then excluding any start DATE-TIME values specified by the RecurrenceExceptionRule or RecurrenceExceptionDates properties. This implies that DATE-TIME values specified by the RecurrenceExceptionRule and RecurrenceExceptionDates properties take precedence over those specified by inclusion properties (i.e., RecurrenceDates and RecurrenceRule). When duplicate instances are generated by the recurrence RecurrenceRule and RecurrenceDates properties, only one recurrence is considered. Duplicate instances are ignored.

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 after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the CalDAV EventDetails event.

Data Type

String

RecurrenceExceptionRule Property (CalDAV Class)

Defines a rule or repeating pattern for an exception to the recurrence set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecurrenceExceptionRule();
int SetRecurrenceExceptionRule(const char* lpszRecurrenceExceptionRule);

Unicode (Windows)
LPWSTR GetRecurrenceExceptionRule();
INT SetRecurrenceExceptionRule(LPCWSTR lpszRecurrenceExceptionRule);

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

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

Default Value

""

Remarks

Defines a rule or repeating pattern for an exception to the recurrence set.

If the RecurrenceExceptionDates and RecurrenceExceptionRule are specified, they are used in computing the recurrence set. 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 RecurrenceRule, RecurrenceDates, RecurrenceExceptionRule, and RecurrenceExceptionDates properties 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 RecurrenceRule and RecurrenceDates properties, and then excluding any start DATE-TIME values specified by the RecurrenceExceptionRule or RecurrenceExceptionDates properties. This implies that DATE-TIME values specified by the RecurrenceExceptionRule and RecurrenceExceptionDates properties take precedence over those specified by inclusion properties (i.e., RecurrenceDates and RecurrenceRule). When duplicate instances are generated by the recurrence RecurrenceRule and RecurrenceDates properties, only one recurrence is considered. Duplicate instances are ignored.

This value type is a structured value consisting of a list of one or more recurrence grammar parts. Each rule part is defined by a NAME=VALUE pair. The rule parts are separated from each other by the SEMICOLON character. The rule parts are not ordered in any particular sequence. Individual rule parts MUST only be specified once.

The table below shows the supported rules and their usage.

Information not contained in the RecurrenceRule necessary to determine the various recurrence instance start time and dates are derived from the StartDate property. For example, "FREQ=YEARLY;BYMONTH=1" doesn't specify a specific day within the month or a time. This information would be the same as what is specified for the StartDate property.

BYxxx rule parts modify the recurrence in some manner. BYxxx rule parts for a period of time that is the same or greater than the frequency generally reduce or limit the number of occurrences of the recurrence generated. For example, "FREQ=DAILY;BYMONTH=1" reduces the number of recurrence instances from all days (if BYMONTH rule part is not present) to all days in January. BYxxx rule parts for a period of time less than the frequency generally increase or expand the number of occurrences of the recurrence. For example, "FREQ=YEARLY;BYMONTH=1,2" increases the number of days within the yearly recurrence set from 1 (if BYMONTH rule part is not present) to 2.

If multiple BYxxx rule parts are specified, then after evaluating the specified FREQ and INTERVAL rule parts, the BYxxx rule parts are applied to the current set of evaluated occurrences in the following order: BYMONTH, BYWEEKNO, BYYEARDAY, BYMONTHDAY, BYDAY, BYHOUR, BYMINUTE, BYSECOND and BYSETPOS; then COUNT and UNTIL are evaluated.

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the CalDAV EventDetails event.

Data Type

String

RecurrenceId Property (CalDAV Class)

Identifies a recurring event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecurrenceId();
int SetRecurrenceId(const char* lpszRecurrenceId);

Unicode (Windows)
LPWSTR GetRecurrenceId();
INT SetRecurrenceId(LPCWSTR lpszRecurrenceId);

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

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

Default Value

""

Remarks

Identifies a recurring event.

This property is used in conjunction with the CalDAV UID and Sequence properties to identify a specific instance of a recurring event, todo, or journal. The value of this property is the value of the CalDAV StartDate property of the original recurrence instance.

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the CalDAV EventDetails event.

Data Type

String

RecurrenceRule Property (CalDAV Class)

This property defines the recurrence rule for the event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecurrenceRule();
int SetRecurrenceRule(const char* lpszRecurrenceRule);

Unicode (Windows)
LPWSTR GetRecurrenceRule();
INT SetRecurrenceRule(LPCWSTR lpszRecurrenceRule);

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

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

Default Value

""

Remarks

This property defines the recurrence rule for the event.

This value type is a structured value consisting of a list of one or more recurrence grammar parts. Each rule part is defined by a NAME=VALUE pair. The rule parts are separated from each other by the SEMICOLON character. The rule parts are not ordered in any particular sequence. Individual rule parts MUST only be specified once.

The table below shows the supported rules and their usage.

Information not contained in the RecurrenceRule necessary to determine the various recurrence instance start time and dates are derived from the StartDate property. For example, "FREQ=YEARLY;BYMONTH=1" doesn't specify a specific day within the month or a time. This information would be the same as what is specified for the StartDate property.

BYxxx rule parts modify the recurrence in some manner. BYxxx rule parts for a period of time that is the same or greater than the frequency generally reduce or limit the number of occurrences of the recurrence generated. For example, "FREQ=DAILY;BYMONTH=1" reduces the number of recurrence instances from all days (if BYMONTH rule part is not present) to all days in January. BYxxx rule parts for a period of time less than the frequency generally increase or expand the number of occurrences of the recurrence. For example, "FREQ=YEARLY;BYMONTH=1,2" increases the number of days within the yearly recurrence set from 1 (if BYMONTH rule part is not present) to 2.

If multiple BYxxx rule parts are specified, then after evaluating the specified FREQ and INTERVAL rule parts, the BYxxx rule parts are applied to the current set of evaluated occurrences in the following order: BYMONTH, BYWEEKNO, BYYEARDAY, BYMONTHDAY, BYDAY, BYHOUR, BYMINUTE, BYSECOND and BYSETPOS; then COUNT and UNTIL are evaluated.

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the CalDAV EventDetails event.

Data Type

String

ReportFilterAlarmEnd Property (CalDAV Class)

Limits the events returned in the report to only those with an alarm set in the range specified by AlarmStart and AlarmEnd .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReportFilterAlarmEnd();
int SetReportFilterAlarmEnd(const char* lpszReportFilterAlarmEnd);

Unicode (Windows)
LPWSTR GetReportFilterAlarmEnd();
INT SetReportFilterAlarmEnd(LPCWSTR lpszReportFilterAlarmEnd);

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

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

Default Value

""

Remarks

Limits the events returned in the report to only those with an alarm set in the range specified by ReportFilterAlarmStart and ReportFilterAlarmEnd. 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.

Data Type

String

ReportFilterAlarmStart Property (CalDAV Class)

Limits the events returned in the report to only those with an alarm set in the range specified by AlarmStart and AlarmEnd .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReportFilterAlarmStart();
int SetReportFilterAlarmStart(const char* lpszReportFilterAlarmStart);

Unicode (Windows)
LPWSTR GetReportFilterAlarmStart();
INT SetReportFilterAlarmStart(LPCWSTR lpszReportFilterAlarmStart);

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

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

Default Value

""

Remarks

Limits the events returned in the report to only those with an alarm set in the range specified by ReportFilterAlarmStart and ReportFilterAlarmEnd. 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.

Data Type

String

ReportFilterCustomFilter Property (CalDAV Class)

Allows the user to specify his own filter XML.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReportFilterCustomFilter();
int SetReportFilterCustomFilter(const char* lpszReportFilterCustomFilter);

Unicode (Windows)
LPWSTR GetReportFilterCustomFilter();
INT SetReportFilterCustomFilter(LPCWSTR lpszReportFilterCustomFilter);

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

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

Default Value

""

Remarks

Allows the user to specify his own filter XML. This property must be properly-formed XML, and must be a supported CalDAV filter or the class fails with an error.

Data Type

String

ReportFilterEndDate Property (CalDAV Class)

Limits the events returned in the report to only those which occur in the time range specified by StartDate and EndDate .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReportFilterEndDate();
int SetReportFilterEndDate(const char* lpszReportFilterEndDate);

Unicode (Windows)
LPWSTR GetReportFilterEndDate();
INT SetReportFilterEndDate(LPCWSTR lpszReportFilterEndDate);

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

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

Default Value

""

Remarks

Limits the events returned in the report to only those which occur in the time range specified by ReportFilterStartDate and ReportFilterEndDate. 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.

Data Type

String

ReportFilterEventType Property (CalDAV Class)

Indicates the type of calendar object resources to return in a Report.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReportFilterEventType();
int SetReportFilterEventType(int iReportFilterEventType);

Unicode (Windows)
INT GetReportFilterEventType();
INT SetReportFilterEventType(INT iReportFilterEventType);

VT_EVENT(0), 
VT_TODO(1), 
VT_JOURNAL(2), 
VT_FREE_BUSY(3), 
VT_ALL(4)

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

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

Default Value

0

Remarks

Indicates the type of calendar object resources to return in a Report. Some calendar servers (Google in particular) do not support vtAll, so you must submit a report for each type of event you wish to retrieve a report on.

Data Type

Integer

ReportFilterProperty Property (CalDAV Class)

Limits the events returned in a Report to only those which contain a matching property name and value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReportFilterProperty();
int SetReportFilterProperty(const char* lpszReportFilterProperty);

Unicode (Windows)
LPWSTR GetReportFilterProperty();
INT SetReportFilterProperty(LPCWSTR lpszReportFilterProperty);

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

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

Default Value

""

Remarks

Limits the events returned in a Report to only those which contain a matching property name and value. For instance, setting the ReportFilterProperty filter to "ORGANIZER" will return only events that have an organizer specified. Setting the ReportFilterProperty filter to "ORGANIZER=mailto:JohnSmith@example.com" will return only resources where "mailto:JohnSmith@example.com" is the specified organizer. Likewise, you can retrieve a report on a single event by setting the ReportFilterProperty filter with the UID of the needed resource. For example: ReportFilterProperty = "UID=DC6C50A017428C5216A2F1CD@example.com";.

You may add multiple properties to the filter by separating them with commas. For example: "ORGANIZER=mailto:JohnSmith@example.com, STATUS=CANCELLED".

For more advanced filtering, you may specify your own ReportFilterCustomFilter.

Data Type

String

ReportFilterRecurEnd Property (CalDAV Class)

Limits the recurring events returned in the report.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReportFilterRecurEnd();
int SetReportFilterRecurEnd(const char* lpszReportFilterRecurEnd);

Unicode (Windows)
LPWSTR GetReportFilterRecurEnd();
INT SetReportFilterRecurEnd(LPCWSTR lpszReportFilterRecurEnd);

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

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

Default Value

""

Remarks

Limits the recurring events returned in the report.

Use of the CalDAV limit-recurrence-set element causes the server to only return overridden recurrence components that overlap the time range specified by ReportFilterRecurStart and ReportFilterRecurEnd or that affect other instances that overlap the time range specified by ReportFilterStartDate and ReportFilterEndDate. 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 that the ReportFilterRecurEnd property cannot be used when ReportFilterReturnCalendarData is False.

Data Type

String

ReportFilterRecurStart Property (CalDAV Class)

Limits the recurring events returned in the report.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReportFilterRecurStart();
int SetReportFilterRecurStart(const char* lpszReportFilterRecurStart);

Unicode (Windows)
LPWSTR GetReportFilterRecurStart();
INT SetReportFilterRecurStart(LPCWSTR lpszReportFilterRecurStart);

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

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

Default Value

""

Remarks

Limits the recurring events returned in the report.

Use of the CalDAV limit-recurrence-set element causes the server to only return overridden recurrence components that overlap the time range specified by ReportFilterRecurStart and ReportFilterRecurEnd or that affect other instances that overlap the time range specified by ReportFilterStartDate and ReportFilterEndDate. 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 that the ReportFilterRecurStart property cannot be used when ReportFilterReturnCalendarData is False.

Data Type

String

ReportFilterReturnCalendarData Property (CalDAV Class)

Controls whether the contents of each calendar event is returned in the report.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReportFilterReturnCalendarData();
int SetReportFilterReturnCalendarData(int bReportFilterReturnCalendarData);

Unicode (Windows)
BOOL GetReportFilterReturnCalendarData();
INT SetReportFilterReturnCalendarData(BOOL bReportFilterReturnCalendarData);

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

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

Default Value

TRUE

Remarks

Controls whether the contents of each calendar event is returned in the report.

If ReportFilterReturnCalendarData is True (default), a report will contain the full contents of each event in the calendar. This can be a substantially large amount of data. However if ReportFilterReturnCalendarData is False, the report returned will contain only URIs and ETags of each calendar event. You may compare the URIs against a cached list and retrieve any new URIs individually via the CalDAV.GetCalendarEvent method. If the ETag for a cached URI has changed, it means that the calendar event has changed, and needs to be retrieved.

Note that this filter is not compatible with the ReportFilterRecurStart and ReportFilterRecurEnd properties.

Data Type

Boolean

ReportFilterStartDate Property (CalDAV Class)

Limits the events returned in the report to only those which occur in the time range specified by StartDate and EndDate .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReportFilterStartDate();
int SetReportFilterStartDate(const char* lpszReportFilterStartDate);

Unicode (Windows)
LPWSTR GetReportFilterStartDate();
INT SetReportFilterStartDate(LPCWSTR lpszReportFilterStartDate);

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

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

Default Value

""

Remarks

Limits the events returned in the report to only those which occur in the time range specified by ReportFilterStartDate and ReportFilterEndDate. 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.

Data Type

String

ReportFilterUID Property (CalDAV Class)

Limits the recurring events returned in the report to only those with the specified UID.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReportFilterUID();
int SetReportFilterUID(const char* lpszReportFilterUID);

Unicode (Windows)
LPWSTR GetReportFilterUID();
INT SetReportFilterUID(LPCWSTR lpszReportFilterUID);

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

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

Default Value

""

Remarks

Limits the recurring events returned in the report to only those with the specified UID.

Data Type

String

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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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

SSLAcceptServerCertEncoded Property (CalDAV Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

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

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

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (CalDAV Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

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

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

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (CalDAV Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

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

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

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (CalDAV Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

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

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

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (CalDAV Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

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

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (CalDAV Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

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

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

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (CalDAV Class)

This specifies the 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:

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

SSLServerCertEncoded Property (CalDAV Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

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

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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

StatusLine Property (CalDAV Class)

This property is the first line of the last server response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetStatusLine();

Unicode (Windows)
LPWSTR GetStatusLine();

char* ipworks_caldav_getstatusline(void* lpObj);

QString GetStatusLine();

Default Value

""

Remarks

This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the class, the error string is the same as the StatusLine property.

The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description].

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

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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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)

A 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.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent 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

TimezoneDSTName Property (CalDAV Class)

The customary name for the daylight-savings time zone.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTimezoneDSTName();
int SetTimezoneDSTName(const char* lpszTimezoneDSTName);

Unicode (Windows)
LPWSTR GetTimezoneDSTName();
INT SetTimezoneDSTName(LPCWSTR lpszTimezoneDSTName);

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

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

Default Value

""

Remarks

The customary name for the daylight-savings time zone. This could be used for displaying dates, and there is no restriction to the format. For instance, Eastern Daylight Time may be represented as "EDT", "Eastern Daylight Time (US & Canada)", or any other arbitrary representation.

The following example shows the CalTimezone set to Eastern time. CalDAV.Timezone.TimezoneId = "US-Eastern"; CalDAV.Timezone.URL = "http://zones.example.com/tz/America-New_York.ics" CalDAV.Timezone.StdName = "Eastern Standard Time (US & Canada)"; CalDAV.Timezone.StdStart = "20071104T020000"; CalDAV.Timezone.StdOffsetFrom = "-400"; CalDAV.Timezone.StdOffsetTo = "-500"; CalDAV.Timezone.StdRule = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11"; CalDAV.TimeZone.DSTName = "Eastern Daylight Time (US & Canada)"; CalDAV.TimeZone.DSTStart = "20070311T020000"; CalDAV.TimeZone.DSTOffsetFrom = "-500"; CalDAV.TimeZone.DSTOffsetTo = "-400"; CalDAV.TimeZone.DSTRule = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";

Data Type

String

TimezoneDSTOffsetFrom Property (CalDAV Class)

The UTC offset that is in use when the onset of this time zone observance begins.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTimezoneDSTOffsetFrom();
int SetTimezoneDSTOffsetFrom(const char* lpszTimezoneDSTOffsetFrom);

Unicode (Windows)
LPWSTR GetTimezoneDSTOffsetFrom();
INT SetTimezoneDSTOffsetFrom(LPCWSTR lpszTimezoneDSTOffsetFrom);