CalDAV Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorks_CalDAV

Procedural Interface

 ipworks_caldav_open();
 ipworks_caldav_close($res);
 ipworks_caldav_register_callback($res, $id, $function);
 ipworks_caldav_get_last_error($res);
 ipworks_caldav_get_last_error_code($res);
 ipworks_caldav_set($res, $id, $index, $value);
 ipworks_caldav_get($res, $id, $index);
 ipworks_caldav_do_addcookie($res, $cookiename, $cookievalue);
 ipworks_caldav_do_addcustomproperty($res, $varname, $varvalue);
 ipworks_caldav_do_config($res, $configurationstring);
 ipworks_caldav_do_copyevent($res, $sourceresourceuri, $destinationresourceuri);
 ipworks_caldav_do_createcalendar($res, $resourceuri, $displayname, $description);
 ipworks_caldav_do_createevent($res, $resourceuri);
 ipworks_caldav_do_deletecalendar($res, $resourceuri);
 ipworks_caldav_do_deleteevent($res, $resourceuri);
 ipworks_caldav_do_doevents($res);
 ipworks_caldav_do_exportics($res);
 ipworks_caldav_do_getcalendaroptions($res, $resourceuri);
 ipworks_caldav_do_getcalendarreport($res, $resourceuri);
 ipworks_caldav_do_getevent($res, $resourceuri);
 ipworks_caldav_do_getfreebusyreport($res, $resourceuri);
 ipworks_caldav_do_importics($res, $calendardata);
 ipworks_caldav_do_interrupt($res);
 ipworks_caldav_do_listcalendars($res, $baseurl);
 ipworks_caldav_do_lockcalendar($res, $resourceuri);
 ipworks_caldav_do_moveevent($res, $sourceresourceuri, $destinationresourceuri);
 ipworks_caldav_do_reset($res);
 ipworks_caldav_do_sendcustomrequest($res, $httpmethod, $url, $requestbody);
 ipworks_caldav_do_unlockcalendar($res, $resourceuri);
 ipworks_caldav_do_updatecalendar($res, $resourceuri, $calindex);
 ipworks_caldav_do_updateevent($res, $resourceuri);

Remarks

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

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

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

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

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

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

• CopyEvent
• DeleteEvent
• MoveEvent
• GetEvent
• CreateEvent

These methods all act upon the calendar collection resource (the calendar itself):

• CreateCalendar
• GetCalendarOptions
• GetCalendarReport
• GetFreeBusyReport

The LockCalendar and UnLockCalendar methods may operate on individual events or on the whole calendar.

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

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

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

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AlarmCount Property (IPWorks_CalDAV Class)

The number of records in the Alarm arrays.

Object Oriented Interface

public function getAlarmCount();
public function setAlarmCount($value);

Procedural Interface

ipworks_caldav_get($res, 1 );
ipworks_caldav_set($res, 1, $value );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getAlarmAction($alarmindex);
public function setAlarmAction($alarmindex, $value);

Procedural Interface

ipworks_caldav_get($res, 2 , $alarmindex);
ipworks_caldav_set($res, 2, $value , $alarmindex);

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 (IPWorks_CalDAV Class)

This property contains a sound file attached to the alarm.

Object Oriented Interface

public function getAlarmAttachment($alarmindex);
public function setAlarmAttachment($alarmindex, $value);

Procedural Interface

ipworks_caldav_get($res, 3 , $alarmindex);
ipworks_caldav_set($res, 3, $value , $alarmindex);

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 (IPWorks_CalDAV Class)

This property contains the MIME-Type of the attachment.

Object Oriented Interface

public function getAlarmAttachmentType($alarmindex);
public function setAlarmAttachmentType($alarmindex, $value);

Procedural Interface

ipworks_caldav_get($res, 4 , $alarmindex);
ipworks_caldav_set($res, 4, $value , $alarmindex);

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 (IPWorks_CalDAV Class)

This property contains the interval between repeating alarms.

Object Oriented Interface

public function getAlarmDuration($alarmindex);
public function setAlarmDuration($alarmindex, $value);

Procedural Interface

ipworks_caldav_get($res, 5 , $alarmindex);
ipworks_caldav_set($res, 5, $value , $alarmindex);

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:

For example, "P4DT12H30M5S" represents a duration of four days, twelve hours, thirty minutes, and five seconds. Unused date/time designators may be left out completely. (A five-minute duration may be represented as simply "PT5M"). Also note that "PT36H" and "P1DT12H" represent the same duration.

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getAlarmMessage($alarmindex);
public function setAlarmMessage($alarmindex, $value);

Procedural Interface

ipworks_caldav_get($res, 6 , $alarmindex);
ipworks_caldav_set($res, 6, $value , $alarmindex);

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getAlarmRecipient($alarmindex);
public function setAlarmRecipient($alarmindex, $value);

Procedural Interface

ipworks_caldav_get($res, 7 , $alarmindex);
ipworks_caldav_set($res, 7, $value , $alarmindex);

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getAlarmRepeat($alarmindex);
public function setAlarmRepeat($alarmindex, $value);

Procedural Interface

ipworks_caldav_get($res, 8 , $alarmindex);
ipworks_caldav_set($res, 8, $value , $alarmindex);

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getAlarmSubject($alarmindex);
public function setAlarmSubject($alarmindex, $value);

Procedural Interface

ipworks_caldav_get($res, 9 , $alarmindex);
ipworks_caldav_set($res, 9, $value , $alarmindex);

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 (IPWorks_CalDAV Class)

This property contains the time when the alarm is triggered.

Object Oriented Interface

public function getAlarmTrigger($alarmindex);
public function setAlarmTrigger($alarmindex, $value);

Procedural Interface

ipworks_caldav_get($res, 10 , $alarmindex);
ipworks_caldav_set($res, 10, $value , $alarmindex);

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:

Either a positive or negative duration may be specified for the AlarmTrigger property. An alarm with a positive duration is triggered after the associated start of the event (or to-do). An alarm with a negative duration is triggered before the start of the event. For instance, the following code instructs an alarm to fire 10 minutes before the event starts: CalDAV.Alarm.Trigger = "-PT10M"

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getAttendees();
public function setAttendees($value);

Procedural Interface

ipworks_caldav_get($res, 11 );
ipworks_caldav_set($res, 11, $value );

Default Value

''

Remarks

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

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

Data Type

String

Authorization Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getAuthorization();
public function setAuthorization($value);

Procedural Interface

ipworks_caldav_get($res, 12 );
ipworks_caldav_set($res, 12, $value );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getAuthScheme();
public function setAuthScheme($value);

Procedural Interface

ipworks_caldav_get($res, 13 );
ipworks_caldav_set($res, 13, $value );

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

CalendarCount Property (IPWorks_CalDAV Class)

The number of records in the Calendar arrays.

Object Oriented Interface

public function getCalendarCount();
public function setCalendarCount($value);

Procedural Interface

ipworks_caldav_get($res, 14 );
ipworks_caldav_set($res, 14, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CalendarColor
• CalendarCTag
• CalendarDescription
• CalendarDisplayName
• CalendarPropertyCount
• CalendarPropertyIndex
• CalendarPropertyName
• CalendarPropertyValue
• CalendarURL

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

This property is not available at design time.

Data Type

Integer

CalendarColor Property (IPWorks_CalDAV Class)

This property specifies the calendar's color.

Object Oriented Interface

public function getCalendarColor($calendarindex);
public function setCalendarColor($calendarindex, $value);

Procedural Interface

ipworks_caldav_get($res, 15 , $calendarindex);
ipworks_caldav_set($res, 15, $value , $calendarindex);

Default Value

''

Remarks

This property specifies the calendar's color. For instance #C2C2C2FF. This property corresponds to the calendar-color property.

The $calendarindex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarCount property.

This property is not available at design time.

Data Type

String

CalendarCTag Property (IPWorks_CalDAV Class)

This property holds the current ctag of the calendar.

Object Oriented Interface

public function getCalendarCTag($calendarindex);
public function setCalendarCTag($calendarindex, $value);

Procedural Interface

ipworks_caldav_get($res, 16 , $calendarindex);
ipworks_caldav_set($res, 16, $value , $calendarindex);

Default Value

''

Remarks

This property holds the current ctag of the calendar. The ctag value is updated by the server when any changes have been made to the calendar. This may be used to determine if any changes have been made to the calendar since the last reported ctag.

The $calendarindex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarCount property.

This property is not available at design time.

Data Type

String

CalendarDescription Property (IPWorks_CalDAV Class)

This property holds the description of the calendar.

Object Oriented Interface

public function getCalendarDescription($calendarindex);
public function setCalendarDescription($calendarindex, $value);

Procedural Interface

ipworks_caldav_get($res, 17 , $calendarindex);
ipworks_caldav_set($res, 17, $value , $calendarindex);

Default Value

''

Remarks

This property holds the description of the calendar. This value corresponds to the calendar-description property.

The $calendarindex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarCount property.

This property is not available at design time.

Data Type

String

CalendarDisplayName Property (IPWorks_CalDAV Class)

This property holds the display name of the calendar.

Object Oriented Interface

public function getCalendarDisplayName($calendarindex);
public function setCalendarDisplayName($calendarindex, $value);

Procedural Interface

ipworks_caldav_get($res, 18 , $calendarindex);
ipworks_caldav_set($res, 18, $value , $calendarindex);

Default Value

''

Remarks

This property holds the display name of the calendar.

The $calendarindex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarCount property.

This property is not available at design time.

Data Type

String

CalendarPropertyCount Property (IPWorks_CalDAV Class)

This property holds the total number of properties of the calendar.

Object Oriented Interface

public function getCalendarPropertyCount($calendarindex);

Procedural Interface

ipworks_caldav_get($res, 19 , $calendarindex);

Default Value

0

Remarks

This property holds the total number of properties of the calendar. This property, in conjunction with CalendarPropertyIndex, CalendarPropertyName and CalendarPropertyValue provide a way to obtain additional property values that do not correspond to existing properties. For instance: for (int i = 0; i < component.Calendars[0].PropertyCount; i++) { //Setting PropertyIndex selects the property component.Calendars[0].PropertyIndex = i; //After selecting the property by setting PropertyIndex output the property name and value Console.WriteLine(component.Calendars[0].PropertyName + ": " + component.Calendars[0].PropertyValue); }

Note that complex properties that include nested elements are not supported at this time and are not present in the property collection.

The $calendarindex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarCount property.

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

Data Type

Integer

CalendarPropertyIndex Property (IPWorks_CalDAV Class)

This property specifies the currently selected property.

Object Oriented Interface

public function getCalendarPropertyIndex($calendarindex);
public function setCalendarPropertyIndex($calendarindex, $value);

Procedural Interface

ipworks_caldav_get($res, 20 , $calendarindex);
ipworks_caldav_set($res, 20, $value , $calendarindex);

Default Value

0

Remarks

This property specifies the currently selected property. Please see CalendarPropertyCount for details.

The $calendarindex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarCount property.

This property is not available at design time.

Data Type

Integer

CalendarPropertyName Property (IPWorks_CalDAV Class)

This property holds the name of the currently selected property.

Object Oriented Interface

public function getCalendarPropertyName($calendarindex);

Procedural Interface

ipworks_caldav_get($res, 21 , $calendarindex);

Default Value

'0'

Remarks

This property holds the name of the currently selected property. Please see CalendarPropertyCount for details.

The $calendarindex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarCount property.

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

Data Type

String

CalendarPropertyValue Property (IPWorks_CalDAV Class)

This property holds the value of the currently selected property.

Object Oriented Interface

public function getCalendarPropertyValue($calendarindex);

Procedural Interface

ipworks_caldav_get($res, 22 , $calendarindex);

Default Value

''

Remarks

This property holds the value of the currently selected property. Please see CalendarPropertyCount for details.

The $calendarindex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarCount property.

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

Data Type

String

CalendarURL Property (IPWorks_CalDAV Class)

This property provides the URL of the calendar.

Object Oriented Interface

public function getCalendarURL($calendarindex);
public function setCalendarURL($calendarindex, $value);

Procedural Interface

ipworks_caldav_get($res, 23 , $calendarindex);
ipworks_caldav_set($res, 23, $value , $calendarindex);

Default Value

''

Remarks

This property provides the URL of the calendar. This URL is used when managing events within a calendar, or managing the calendar itself.

The $calendarindex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarCount property.

This property is not available at design time.

Data Type

String

Categories Property (IPWorks_CalDAV Class)

Used to specify categories or subtypes of the calendar event.

Object Oriented Interface

public function getCategories();
public function setCategories($value);

Procedural Interface

ipworks_caldav_get($res, 24 );
ipworks_caldav_set($res, 24, $value );

Default Value

''

Remarks

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

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

Data Type

String

Classification Property (IPWorks_CalDAV Class)

Defines the access classification for a calendar class.

Object Oriented Interface

public function getClassification();
public function setClassification($value);

Procedural Interface

ipworks_caldav_get($res, 25 );
ipworks_caldav_set($res, 25, $value );

Default Value

''

Remarks

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

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

Data Type

String

Completed Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getCompleted();
public function setCompleted($value);

Procedural Interface

ipworks_caldav_get($res, 26 );
ipworks_caldav_set($res, 26, $value );

Default Value

''

Remarks

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

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

Data Type

String

Connected Property (IPWorks_CalDAV Class)

Whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworks_caldav_get($res, 27 );

Default Value

false

Remarks

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

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

Data Type

Boolean

CookieCount Property (IPWorks_CalDAV Class)

The number of records in the Cookie arrays.

Object Oriented Interface

public function getCookieCount();
public function setCookieCount($value);

Procedural Interface

ipworks_caldav_get($res, 28 );
ipworks_caldav_set($res, 28, $value );

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 (IPWorks_CalDAV Class)

The domain of a received cookie.

Object Oriented Interface

public function getCookieDomain($cookieindex);

Procedural Interface

ipworks_caldav_get($res, 29 , $cookieindex);

Default Value

''

Remarks

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 (IPWorks_CalDAV Class)

An expiration time for the cookie (if provided by the server).

Object Oriented Interface

public function getCookieExpiration($cookieindex);

Procedural Interface

ipworks_caldav_get($res, 30 , $cookieindex);

Default Value

''

Remarks

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 (IPWorks_CalDAV Class)

The name of the cookie.

Object Oriented Interface

public function getCookieName($cookieindex);
public function setCookieName($cookieindex, $value);

Procedural Interface

ipworks_caldav_get($res, 31 , $cookieindex);
ipworks_caldav_set($res, 31, $value , $cookieindex);

Default Value

''

Remarks

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 (IPWorks_CalDAV Class)

A path name to limit the cookie to (if provided by the server).

Object Oriented Interface

public function getCookiePath($cookieindex);

Procedural Interface

ipworks_caldav_get($res, 32 , $cookieindex);

Default Value

''

Remarks

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 (IPWorks_CalDAV Class)

The security flag of the received cookie.

Object Oriented Interface

public function getCookieSecure($cookieindex);

Procedural Interface

ipworks_caldav_get($res, 33 , $cookieindex);

Default Value

false

Remarks

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 (IPWorks_CalDAV Class)

The value of the cookie.

Object Oriented Interface

public function getCookieValue($cookieindex);
public function setCookieValue($cookieindex, $value);

Procedural Interface

ipworks_caldav_get($res, 34 , $cookieindex);
ipworks_caldav_set($res, 34, $value , $cookieindex);

Default Value

''

Remarks

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

CustomPropertyCount Property (IPWorks_CalDAV Class)

The number of records in the CustomProperty arrays.

Object Oriented Interface

public function getCustomPropertyCount();
public function setCustomPropertyCount($value);

Procedural Interface

ipworks_caldav_get($res, 35 );
ipworks_caldav_set($res, 35, $value );

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 (IPWorks_CalDAV Class)

This property contains an optional attribute of the custom property.

Object Oriented Interface

public function getCustomPropertyAttribute($custompropertyindex);
public function setCustomPropertyAttribute($custompropertyindex, $value);

Procedural Interface

ipworks_caldav_get($res, 36 , $custompropertyindex);
ipworks_caldav_set($res, 36, $value , $custompropertyindex);

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 (IPWorks_CalDAV Class)

This property contains the textual name of the custom property.

Object Oriented Interface

public function getCustomPropertyName($custompropertyindex);
public function setCustomPropertyName($custompropertyindex, $value);

Procedural Interface

ipworks_caldav_get($res, 37 , $custompropertyindex);
ipworks_caldav_set($res, 37, $value , $custompropertyindex);

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 (IPWorks_CalDAV Class)

This property contains the value of the custom property.

Object Oriented Interface

public function getCustomPropertyValue($custompropertyindex);
public function setCustomPropertyValue($custompropertyindex, $value);

Procedural Interface

ipworks_caldav_get($res, 38 , $custompropertyindex);
ipworks_caldav_set($res, 38, $value , $custompropertyindex);

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

Description Property (IPWorks_CalDAV Class)

Provides a complete description of the calendar event.

Object Oriented Interface

public function getDescription();
public function setDescription($value);

Procedural Interface

ipworks_caldav_get($res, 39 );
ipworks_caldav_set($res, 39, $value );

Default Value

''

Remarks

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

Data Type

String

DueDate Property (IPWorks_CalDAV Class)

Specifies the due date for a calendar event.

Object Oriented Interface

public function getDueDate();
public function setDueDate($value);

Procedural Interface

ipworks_caldav_get($res, 40 );
ipworks_caldav_set($res, 40, $value );

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 (IPWorks_CalDAV Class)

Duration of the calendar event.

Object Oriented Interface

public function getDuration();
public function setDuration($value);

Procedural Interface

ipworks_caldav_get($res, 41 );
ipworks_caldav_set($res, 41, $value );

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:

For example, "P4DT12H30M5S" represents a duration of four days, twelve hours, thirty minutes, and five seconds. Unused date/time designators may be left out completely. (A five-minute duration may be represented as simply "PT5M"). Also note that "PT36H" and "P1DT12H" represent the same duration.

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

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

Data Type

String

EndDate Property (IPWorks_CalDAV Class)

Specifies the date and time that a calendar event ends.

Object Oriented Interface

public function getEndDate();
public function setEndDate($value);

Procedural Interface

ipworks_caldav_get($res, 42 );
ipworks_caldav_set($res, 42, $value );

Default Value

''

Remarks

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

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

Data Type

String

ETag Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getETag();
public function setETag($value);

Procedural Interface

ipworks_caldav_get($res, 43 );
ipworks_caldav_set($res, 43, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

EventType Property (IPWorks_CalDAV Class)

Indicates the type of calendar object resource.

Object Oriented Interface

public function getEventType();
public function setEventType($value);

Procedural Interface

ipworks_caldav_get($res, 44 );
ipworks_caldav_set($res, 44, $value );

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallAutoDetect Property (IPWorks_CalDAV Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworks_caldav_get($res, 45 );
ipworks_caldav_set($res, 45, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorks_CalDAV Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworks_caldav_get($res, 46 );
ipworks_caldav_set($res, 46, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorks_CalDAV Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworks_caldav_get($res, 47 );
ipworks_caldav_set($res, 47, $value );

Default Value

''

Remarks

The name or IP address of the 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 (IPWorks_CalDAV Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

ipworks_caldav_get($res, 48 );
ipworks_caldav_set($res, 48, $value );

Default Value

''

Remarks

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 (IPWorks_CalDAV Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworks_caldav_get($res, 49 );
ipworks_caldav_set($res, 49, $value );

Default Value

0

Remarks

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 (IPWorks_CalDAV Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworks_caldav_get($res, 50 );
ipworks_caldav_set($res, 50, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property 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 (IPWorks_CalDAV Class)

Determines what happens when the server issues a redirect.

Object Oriented Interface

public function getFollowRedirects();
public function setFollowRedirects($value);

Procedural Interface

ipworks_caldav_get($res, 51 );
ipworks_caldav_set($res, 51, $value );

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 (IPWorks_CalDAV Class)

The number of records in the FreeBusy arrays.

Object Oriented Interface

public function getFreeBusyCount();

Procedural Interface

ipworks_caldav_get($res, 52 );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getFreeBusyRange($freebusyindex);

Procedural Interface

ipworks_caldav_get($res, 53 , $freebusyindex);

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:

For example, "P4DT12H30M5S" represents a duration of four days, twelve hours, thirty minutes, and five seconds. Unused date/time designators may be left out completely. (A five-minute duration may be represented as simply "PT5M"). Also note that "PT36H" and "P1DT12H" represent the same duration.

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 (IPWorks_CalDAV Class)

Indicates the busy status of the corresponding BusyRange .

Object Oriented Interface

public function getFreeBusyType($freebusyindex);

Procedural Interface

ipworks_caldav_get($res, 54 , $freebusyindex);

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 (IPWorks_CalDAV Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworks_caldav_get($res, 55 );

Default Value

true

Remarks

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

This property is read-only.

Data Type

Boolean

LastModified Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getLastModified();
public function setLastModified($value);

Procedural Interface

ipworks_caldav_get($res, 56 );
ipworks_caldav_set($res, 56, $value );

Default Value

''

Remarks

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

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

Data Type

String

LocalHost Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworks_caldav_get($res, 57 );
ipworks_caldav_set($res, 57, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

Location Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getLocation();
public function setLocation($value);

Procedural Interface

ipworks_caldav_get($res, 58 );
ipworks_caldav_set($res, 58, $value );

Default Value

''

Remarks

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

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

Data Type

String

LockType Property (IPWorks_CalDAV Class)

The type of the current resource lock.

Object Oriented Interface

public function getLockType();
public function setLockType($value);

Procedural Interface

ipworks_caldav_get($res, 59 );
ipworks_caldav_set($res, 59, $value );

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 (IPWorks_CalDAV Class)

The principle that owns the current resource lock.

Object Oriented Interface

public function getLockOwner();
public function setLockOwner($value);

Procedural Interface

ipworks_caldav_get($res, 60 );
ipworks_caldav_set($res, 60, $value );

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 (IPWorks_CalDAV Class)

The scope of the current resource lock.

Object Oriented Interface

public function getLockScope();
public function setLockScope($value);

Procedural Interface

ipworks_caldav_get($res, 61 );
ipworks_caldav_set($res, 61, $value );

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 (IPWorks_CalDAV Class)

The time to live for the current resource lock.

Object Oriented Interface

public function getLockTimeout();
public function setLockTimeout($value);

Procedural Interface

ipworks_caldav_get($res, 62 );
ipworks_caldav_set($res, 62, $value );

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

LockToken Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getLockToken();
public function setLockToken($value);

Procedural Interface

ipworks_caldav_get($res, 63 );
ipworks_caldav_set($res, 63, $value );

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 LockToken may be set to the token 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, LockToken must be empty, and will be parsed out of the server response after a successful LockCalendar operation.

Data Type

String

Organizer Property (IPWorks_CalDAV Class)

Defines the organizer of a calendar event.

Object Oriented Interface

public function getOrganizer();
public function setOrganizer($value);

Procedural Interface

ipworks_caldav_get($res, 64 );
ipworks_caldav_set($res, 64, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

OtherHeaders Property (IPWorks_CalDAV Class)

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

ipworks_caldav_get($res, 65 );
ipworks_caldav_set($res, 65, $value );

Default Value

''

Remarks

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

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

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

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

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

This property is not available at design time.

Data Type

String

ParsedHeaderCount Property (IPWorks_CalDAV Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

ipworks_caldav_get($res, 66 );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

ipworks_caldav_get($res, 67 , $parsedheaderindex);

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 (IPWorks_CalDAV Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

ipworks_caldav_get($res, 68 , $parsedheaderindex);

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

ipworks_caldav_get($res, 69 );
ipworks_caldav_set($res, 69, $value );

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 (IPWorks_CalDAV Class)

Defines the relative priority for a calendar event.

Object Oriented Interface

public function getPriority();
public function setPriority($value);

Procedural Interface

ipworks_caldav_get($res, 70 );
ipworks_caldav_set($res, 70, $value );

Default Value

0

Remarks

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

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

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

Data Type

Integer

ProxyAuthScheme Property (IPWorks_CalDAV Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

ipworks_caldav_get($res, 71 );
ipworks_caldav_set($res, 71, $value );

Default Value

0

Remarks

The 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 class 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 (IPWorks_CalDAV Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

ipworks_caldav_get($res, 72 );
ipworks_caldav_set($res, 72, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (IPWorks_CalDAV Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

ipworks_caldav_get($res, 73 );
ipworks_caldav_set($res, 73, $value );

Default Value

''

Remarks

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

ProxyPort Property (IPWorks_CalDAV Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

ipworks_caldav_get($res, 74 );
ipworks_caldav_set($res, 74, $value );

Default Value

80

Remarks

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

ipworks_caldav_get($res, 75 );
ipworks_caldav_set($res, 75, $value );

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 (IPWorks_CalDAV Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

ipworks_caldav_get($res, 76 );
ipworks_caldav_set($res, 76, $value );

Default Value

0

Remarks

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 (IPWorks_CalDAV Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

ipworks_caldav_get($res, 77 );
ipworks_caldav_set($res, 77, $value );

Default Value

''

Remarks

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 (IPWorks_CalDAV Class)

Individual dates on which the event will recur.

Object Oriented Interface

public function getRecurrenceDates();
public function setRecurrenceDates($value);

Procedural Interface

ipworks_caldav_get($res, 78 );
ipworks_caldav_set($res, 78, $value );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getRecurrenceExceptionDates();
public function setRecurrenceExceptionDates($value);

Procedural Interface

ipworks_caldav_get($res, 79 );
ipworks_caldav_set($res, 79, $value );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getRecurrenceExceptionRule();
public function setRecurrenceExceptionRule($value);

Procedural Interface

ipworks_caldav_get($res, 80 );
ipworks_caldav_set($res, 80, $value );

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.

Note: The BYSECOND, BYMINUTE and BYHOUR rule parts MUST NOT be specified when the associated StartDate property is specified.

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 (IPWorks_CalDAV Class)

Identifies a recurring event.

Object Oriented Interface

public function getRecurrenceId();
public function setRecurrenceId($value);

Procedural Interface

ipworks_caldav_get($res, 81 );
ipworks_caldav_set($res, 81, $value );

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 (IPWorks_CalDAV Class)

This property defines the recurrence rule for the event.

Object Oriented Interface

public function getRecurrenceRule();
public function setRecurrenceRule($value);

Procedural Interface

ipworks_caldav_get($res, 82 );
ipworks_caldav_set($res, 82, $value );

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.

Note: The BYSECOND, BYMINUTE and BYHOUR rule parts MUST NOT be specified when the associated StartDate property is specified.

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

RelatedTo Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getRelatedTo();
public function setRelatedTo($value);

Procedural Interface

ipworks_caldav_get($res, 83 );
ipworks_caldav_set($res, 83, $value );

Default Value

''

Remarks

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

Data Type

String

ReportFilterAlarmEnd Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getReportFilterAlarmEnd();
public function setReportFilterAlarmEnd($value);

Procedural Interface

ipworks_caldav_get($res, 84 );
ipworks_caldav_set($res, 84, $value );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getReportFilterAlarmStart();
public function setReportFilterAlarmStart($value);

Procedural Interface

ipworks_caldav_get($res, 85 );
ipworks_caldav_set($res, 85, $value );

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 (IPWorks_CalDAV Class)

Allows the user to specify his own filter XML.

Object Oriented Interface

public function getReportFilterCustomFilter();
public function setReportFilterCustomFilter($value);

Procedural Interface

ipworks_caldav_get($res, 86 );
ipworks_caldav_set($res, 86, $value );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getReportFilterEndDate();
public function setReportFilterEndDate($value);

Procedural Interface

ipworks_caldav_get($res, 87 );
ipworks_caldav_set($res, 87, $value );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getReportFilterEventType();
public function setReportFilterEventType($value);

Procedural Interface

ipworks_caldav_get($res, 88 );
ipworks_caldav_set($res, 88, $value );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getReportFilterProperty();
public function setReportFilterProperty($value);

Procedural Interface

ipworks_caldav_get($res, 89 );
ipworks_caldav_set($res, 89, $value );

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 (IPWorks_CalDAV Class)

Limits the recurring events returned in the report.

Object Oriented Interface

public function getReportFilterRecurEnd();
public function setReportFilterRecurEnd($value);

Procedural Interface

ipworks_caldav_get($res, 90 );
ipworks_caldav_set($res, 90, $value );

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 (IPWorks_CalDAV Class)

Limits the recurring events returned in the report.

Object Oriented Interface

public function getReportFilterRecurStart();
public function setReportFilterRecurStart($value);

Procedural Interface

ipworks_caldav_get($res, 91 );
ipworks_caldav_set($res, 91, $value );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getReportFilterReturnCalendarData();
public function setReportFilterReturnCalendarData($value);

Procedural Interface

ipworks_caldav_get($res, 92 );
ipworks_caldav_set($res, 92, $value );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getReportFilterStartDate();
public function setReportFilterStartDate($value);

Procedural Interface

ipworks_caldav_get($res, 93 );
ipworks_caldav_set($res, 93, $value );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getReportFilterUID();
public function setReportFilterUID($value);

Procedural Interface

ipworks_caldav_get($res, 94 );
ipworks_caldav_set($res, 94, $value );

Default Value

''

Remarks

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

Data Type

String

Sequence Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getSequence();
public function setSequence($value);

Procedural Interface

ipworks_caldav_get($res, 95 );
ipworks_caldav_set($res, 95, $value );

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (IPWorks_CalDAV Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworks_caldav_get($res, 96 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorks_CalDAV Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworks_caldav_get($res, 97 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorks_CalDAV Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworks_caldav_get($res, 98 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorks_CalDAV Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworks_caldav_get($res, 99 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorks_CalDAV Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworks_caldav_get($res, 100 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorks_CalDAV Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworks_caldav_get($res, 101 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorks_CalDAV Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworks_caldav_get($res, 102 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorks_CalDAV Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworks_caldav_get($res, 103 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorks_CalDAV Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworks_caldav_get($res, 104 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorks_CalDAV Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworks_caldav_get($res, 105 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorks_CalDAV Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworks_caldav_get($res, 106 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorks_CalDAV Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks_caldav_get($res, 107 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorks_CalDAV Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworks_caldav_get($res, 108 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorks_CalDAV Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworks_caldav_get($res, 109 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorks_CalDAV Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworks_caldav_get($res, 110 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorks_CalDAV Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworks_caldav_get($res, 111 );
ipworks_caldav_set($res, 111, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorks_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.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworks_caldav_get($res, 112 );
ipworks_caldav_set($res, 112, $value );

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

SSLAcceptServerCertStoreType Property (IPWorks_CalDAV Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworks_caldav_get($res, 113 );
ipworks_caldav_set($res, 113, $value );

Default Value

0

Remarks

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

SSLAcceptServerCertSubjectAltNames Property (IPWorks_CalDAV Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworks_caldav_get($res, 114 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorks_CalDAV Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworks_caldav_get($res, 115 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorks_CalDAV Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworks_caldav_get($res, 116 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorks_CalDAV Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworks_caldav_get($res, 117 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorks_CalDAV Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworks_caldav_get($res, 118 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorks_CalDAV Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworks_caldav_get($res, 119 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorks_CalDAV Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworks_caldav_get($res, 120 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorks_CalDAV Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworks_caldav_get($res, 121 );
ipworks_caldav_set($res, 121, $value );

Default Value

''

Remarks

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

SSLAcceptServerCertEncoded Property (IPWorks_CalDAV Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworks_caldav_get($res, 122 );
ipworks_caldav_set($res, 122, $value );

Default Value

''

Remarks

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

SSLCertEffectiveDate Property (IPWorks_CalDAV Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworks_caldav_get($res, 123 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorks_CalDAV Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworks_caldav_get($res, 124 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorks_CalDAV Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworks_caldav_get($res, 125 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorks_CalDAV Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworks_caldav_get($res, 126 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorks_CalDAV Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworks_caldav_get($res, 127 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorks_CalDAV Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworks_caldav_get($res, 128 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorks_CalDAV Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworks_caldav_get($res, 129 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorks_CalDAV Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworks_caldav_get($res, 130 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorks_CalDAV Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworks_caldav_get($res, 131 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorks_CalDAV Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworks_caldav_get($res, 132 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorks_CalDAV Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworks_caldav_get($res, 133 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorks_CalDAV Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworks_caldav_get($res, 134 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorks_CalDAV Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworks_caldav_get($res, 135 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorks_CalDAV Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworks_caldav_get($res, 136 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorks_CalDAV Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworks_caldav_get($res, 137 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorks_CalDAV Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworks_caldav_get($res, 138 );
ipworks_caldav_set($res, 138, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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 (IPWorks_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.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworks_caldav_get($res, 139 );
ipworks_caldav_set($res, 139, $value );

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 (IPWorks_CalDAV Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworks_caldav_get($res, 140 );
ipworks_caldav_set($res, 140, $value );

Default Value

0

Remarks

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

SSLCertSubjectAltNames Property (IPWorks_CalDAV Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworks_caldav_get($res, 141 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorks_CalDAV Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworks_caldav_get($res, 142 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorks_CalDAV Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworks_caldav_get($res, 143 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorks_CalDAV Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworks_caldav_get($res, 144 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorks_CalDAV Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworks_caldav_get($res, 145 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorks_CalDAV Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworks_caldav_get($res, 146 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorks_CalDAV Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworks_caldav_get($res, 147 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorks_CalDAV Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworks_caldav_get($res, 148 );
ipworks_caldav_set($res, 148, $value );

Default Value

''

Remarks

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

SSLCertEncoded Property (IPWorks_CalDAV Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworks_caldav_get($res, 149 );
ipworks_caldav_set($res, 149, $value );

Default Value

''

Remarks

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

SSLProvider Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

ipworks_caldav_get($res, 150 );
ipworks_caldav_set($res, 150, $value );

Default Value

0

Remarks

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

Possible values are as follows:

Additional Notes

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

SSLServerCertEffectiveDate Property (IPWorks_CalDAV Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworks_caldav_get($res, 151 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorks_CalDAV Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworks_caldav_get($res, 152 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorks_CalDAV Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworks_caldav_get($res, 153 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorks_CalDAV Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworks_caldav_get($res, 154 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorks_CalDAV Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworks_caldav_get($res, 155 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorks_CalDAV Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworks_caldav_get($res, 156 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorks_CalDAV Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworks_caldav_get($res, 157 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorks_CalDAV Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworks_caldav_get($res, 158 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorks_CalDAV Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworks_caldav_get($res, 159 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorks_CalDAV Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworks_caldav_get($res, 160 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorks_CalDAV Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworks_caldav_get($res, 161 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorks_CalDAV Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks_caldav_get($res, 162 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorks_CalDAV Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworks_caldav_get($res, 163 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorks_CalDAV Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworks_caldav_get($res, 164 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorks_CalDAV Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworks_caldav_get($res, 165 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorks_CalDAV Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworks_caldav_get($res, 166 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorks_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.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

ipworks_caldav_get($res, 167 );

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorks_CalDAV Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworks_caldav_get($res, 168 );

Default Value

0

Remarks

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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorks_CalDAV Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworks_caldav_get($res, 169 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorks_CalDAV Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworks_caldav_get($res, 170 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorks_CalDAV Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworks_caldav_get($res, 171 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorks_CalDAV Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworks_caldav_get($res, 172 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorks_CalDAV Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworks_caldav_get($res, 173 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorks_CalDAV Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworks_caldav_get($res, 174 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorks_CalDAV Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworks_caldav_get($res, 175 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorks_CalDAV Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworks_caldav_get($res, 176 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorks_CalDAV Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworks_caldav_get($res, 177 );

Default Value

''

Remarks

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 (IPWorks_CalDAV Class)

Specifies the date and time that an event begins.

Object Oriented Interface

public function getStartDate();
public function setStartDate($value);

Procedural Interface

ipworks_caldav_get($res, 178 );
ipworks_caldav_set($res, 178, $value );

Default Value

''

Remarks

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

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

Data Type

String

Status Property (IPWorks_CalDAV Class)

Defines the overall status or confirmation for the calendar event.

Object Oriented Interface

public function getStatus();
public function setStatus($value);

Procedural Interface

ipworks_caldav_get($res, 179 );
ipworks_caldav_set($res, 179, $value );

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:

Statuses for a vTodo EventType: Statuses for a vJournal EventType:

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

Data Type

String

Summary Property (IPWorks_CalDAV Class)

Defines a short summary or subject for the calendar event.

Object Oriented Interface

public function getSummary();
public function setSummary($value);

Procedural Interface

ipworks_caldav_get($res, 180 );
ipworks_caldav_set($res, 180, $value );

Default Value

''

Remarks

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

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

Data Type

String

Timeout Property (IPWorks_CalDAV Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworks_caldav_get($res, 181 );
ipworks_caldav_set($res, 181, $value );

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

Timestamp Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getTimestamp();
public function setTimestamp($value);

Procedural Interface

ipworks_caldav_get($res, 182 );
ipworks_caldav_set($res, 182, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

TimezoneDSTName Property (IPWorks_CalDAV Class)

The customary name for the daylight-savings time zone.

Object Oriented Interface

public function getTimezoneDSTName();
public function setTimezoneDSTName($value);

Procedural Interface

ipworks_caldav_get($res, 183 );
ipworks_caldav_set($res, 183, $value );

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 (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getTimezoneDSTOffsetFrom();
public function setTimezoneDSTOffsetFrom($value);

Procedural Interface

ipworks_caldav_get($res, 184 );
ipworks_caldav_set($res, 184, $value );

Default Value

''

Remarks

The UTC offset that is in use when the onset of this time zone observance begins. TimezoneDSTOffsetFrom is combined with TimezoneDSTStart to define the effective onset for the daylight-time time zone definition.

TimezoneDSTStart, TimezoneDSTOffsetFrom, and TimezoneDSTOffsetTo are all required to specify the daylight-savings time zone.

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

TimezoneDSTOffsetTo Property (IPWorks_CalDAV Class)

The UTC offset for daylight savings time, when this observance is in use.

Object Oriented Interface

public function getTimezoneDSTOffsetTo();
public function setTimezoneDSTOffsetTo($value);

Procedural Interface

ipworks_caldav_get($res, 185 );
ipworks_caldav_set($res, 185, $value );

Default Value

''

Remarks

The UTC offset for daylight savings time, when this observance is in use.

TimezoneDSTStart, TimezoneDSTOffsetFrom, and TimezoneDSTOffsetTo are all required to specify the daylight-savings time zone.

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

TimezoneDSTRule Property (IPWorks_CalDAV Class)

This property defines the recurrence rule for the onset of this daylight savings time observance.

Object Oriented Interface

public function getTimezoneDSTRule();
public function setTimezoneDSTRule($value);

Procedural Interface

ipworks_caldav_get($res, 186 );
ipworks_caldav_set($res, 186, $value );

Default Value

''

Remarks

This property defines the recurrence rule for the onset of this daylight savings time observance. Some specific requirements for the usage of TimezoneDSTRule for this purpose include:

Note that the TimezoneDSTStart and TimezoneDSTOffsetFrom properties must be used when generating the onset DATE-TIME values (instances) from the TimezoneDSTRule

For instance, in the USA Eastern Daylight time before 2007 started on the first Sunday of April. In 2007 Daylight time was changed to begin on the 2nd Sunday in March. Therefore, the UNTIL option should indicate the LAST time this rule will be observed. (2am on April 2nd, 2006). Such a time zone declaration would look like this: CalDAV.time zone.DSTName = "EDT" CalDAV.time zone.DSTStart = "19870405T020000" CalDAV.time zone.DSTOffsetFrom = "-500" CalDAV.time zone.DSTOffsetTo = "-400" CalDAV.time zone.DSTRule = "FREQ=YEARLY;BYMONTH=4;BYDAY=1SU;UNTIL=20060402T070000Z"

Data Type

String

TimezoneDSTStart Property (IPWorks_CalDAV Class)

The effective onset date and local time for the daylight-time time zone definition.

Object Oriented Interface

public function getTimezoneDSTStart();
public function setTimezoneDSTStart($value);

Procedural Interface

ipworks_caldav_get($res, 187 );
ipworks_caldav_set($res, 187, $value );

Default Value

''

Remarks

The effective onset date and local time for the daylight-time time zone definition. The date and time MUST be specified as a date with a local time value in the format "YYYYMMDDThhmmss", where "T" indicates the break between date and time.

TimezoneDSTStart, TimezoneDSTOffsetFrom, and TimezoneDSTOffsetTo are all required to specify the daylight-savings time zone.

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

TimezoneLastModified Property (IPWorks_CalDAV Class)

This optional property is a UTC value that specifies the date and time that this time zone definition was last updated.

Object Oriented Interface

public function getTimezoneLastModified();
public function setTimezoneLastModified($value);

Procedural Interface

ipworks_caldav_get($res, 188 );
ipworks_caldav_set($res, 188, $value );

Default Value

''

Remarks

This optional property is a UTC value that specifies the date and time that this time zone definition was last updated.

Data Type

String

TimezoneStdName Property (IPWorks_CalDAV Class)

The customary name for the standard time zone.

Object Oriented Interface

public function getTimezoneStdName();
public function setTimezoneStdName($value);

Procedural Interface

ipworks_caldav_get($res, 189 );
ipworks_caldav_set($res, 189, $value );

Default Value

''

Remarks

The customary name for the standard time zone. This could be used for displaying dates, and there is no restriction to the format. For instance, Eastern Standard Time may be represented as "EST", "Eastern Standard 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

TimezoneStdOffsetFrom Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getTimezoneStdOffsetFrom();
public function setTimezoneStdOffsetFrom($value);

Procedural Interface

ipworks_caldav_get($res, 190 );
ipworks_caldav_set($res, 190, $value );

Default Value

''

Remarks

The UTC offset that is in use when the onset of this time zone observance begins. TimezoneStdOffsetFrom is combined with TimezoneStdStart to define the effective onset for the standard-time time zone definition.

TimezoneStdStart, TimezoneStdOffsetFrom, and TimezoneStdOffsetTo are all required to specify the standard-time time zone.

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

TimezoneStdOffsetTo Property (IPWorks_CalDAV Class)

The UTC offset for standard time, when this observance is in use.

Object Oriented Interface

public function getTimezoneStdOffsetTo();
public function setTimezoneStdOffsetTo($value);

Procedural Interface

ipworks_caldav_get($res, 191 );
ipworks_caldav_set($res, 191, $value );

Default Value

''

Remarks

The UTC offset for standard time, when this observance is in use.

TimezoneStdStart, TimezoneStdOffsetFrom, and TimezoneStdOffsetTo are all required to specify the standard-time time zone.

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

TimezoneStdRule Property (IPWorks_CalDAV Class)

This property defines the recurrence rule for the onset of this standard time observance.

Object Oriented Interface

public function getTimezoneStdRule();
public function setTimezoneStdRule($value);

Procedural Interface

ipworks_caldav_get($res, 192 );
ipworks_caldav_set($res, 192, $value );

Default Value

''

Remarks

This property defines the recurrence rule for the onset of this standard time observance. Some specific requirements for the usage of TimezoneDSTRule for this purpose include:

Note that the TimezoneStdStart and TimezoneStdOffsetFrom properties must be used when generating the onset DATE-TIME values (instances) from the TimezoneStdRule

For instance, in the USA Eastern Standard time before 2007 started on the last Sunday of October. In 2007 Standard time was changed to begin on the 1st Sunday in November. Therefore, the UNTIL option should indicate the LAST time this rule will be observed. (2am on October 29th, 2006). Such a time zone declaration would look like this: CalDAV.time zone.StdName = "EST" CalDAV.time zone.StdStart = "19671029T020000" CalDAV.time zone.StdOffsetFrom = "-400" CalDAV.time zone.StdOffsetTo = "-500" CalDAV.time zone.StdRule = "FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU;UNTIL=20061029T060000Z"

Data Type

String

TimezoneStdStart Property (IPWorks_CalDAV Class)

The effective onset date and local time for the standard-time time zone definition.

Object Oriented Interface

public function getTimezoneStdStart();
public function setTimezoneStdStart($value);

Procedural Interface

ipworks_caldav_get($res, 193 );
ipworks_caldav_set($res, 193, $value );

Default Value

''

Remarks

The effective onset date and local time for the standard-time time zone definition. The date and time MUST be specified as a date with a local time value. in the format "YYYYMMDDThhmmss", where "T" indicates the break between date and time.

TimezoneStdStart, TimezoneStdOffsetFrom, and TimezoneStdOffsetTo are all required to specify the standard-time time zone.

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

TimezoneId Property (IPWorks_CalDAV Class)

This property specifies a text value that uniquely identifies this CalTimezone calendar class.

Object Oriented Interface

public function getTimezoneId();
public function setTimezoneId($value);

Procedural Interface

ipworks_caldav_get($res, 194 );
ipworks_caldav_set($res, 194, $value );

Default Value

''

Remarks

This property specifies a text value that uniquely identifies this CalTimezone calendar component.

Note: This document does not define a naming convention for time zone identifiers. Implementers may want to use the naming conventions defined in existing time zone specifications such as the public-domain TZ database [TZDB].

This property is required. If it is not present, no time zone information will be generated inside the MakeCalendar request.

Data Type

String

TimezoneURL Property (IPWorks_CalDAV Class)

Optionally points to a published time zone definition.

Object Oriented Interface

public function getTimezoneURL();
public function setTimezoneURL($value);

Procedural Interface

ipworks_caldav_get($res, 195 );
ipworks_caldav_set($res, 195, $value );

Default Value

''

Remarks

Optionally points to a published time zone definition. If set, this property should refer to a resource that is accessible by anyone who might need to interpret the object. This should not normally be a "file" URL or other URL that is not widely accessible.

Data Type

String

Transparency Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getTransparency();
public function setTransparency($value);

Procedural Interface

ipworks_caldav_get($res, 196 );
ipworks_caldav_set($res, 196, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

UID Property (IPWorks_CalDAV Class)

A persistent, globally unique identifier for the calendar event.

Object Oriented Interface

public function getUID();
public function setUID($value);

Procedural Interface

ipworks_caldav_get($res, 197 );
ipworks_caldav_set($res, 197, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

URL Property (IPWorks_CalDAV Class)

Location of the event resource on the CalDAV server.

Object Oriented Interface

public function getURL();

Procedural Interface

ipworks_caldav_get($res, 198 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

User Property (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function getUser();
public function setUser($value);

Procedural Interface

ipworks_caldav_get($res, 199 );
ipworks_caldav_set($res, 199, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

AddCookie Method (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function doAddCookie($cookiename, $cookievalue);

Procedural Interface

ipworks_caldav_do_addcookie($res, $cookiename, $cookievalue);

Remarks

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

AddCustomProperty Method (IPWorks_CalDAV Class)

Adds a form variable and the corresponding value.

Object Oriented Interface

public function doAddCustomProperty($varname, $varvalue);

Procedural Interface

ipworks_caldav_do_addcustomproperty($res, $varname, $varvalue);

Remarks

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

Example using the AddCustomProperty method:

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

Config Method (IPWorks_CalDAV Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_caldav_do_config($res, $configurationstring);

Remarks

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

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

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

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

CopyEvent Method (IPWorks_CalDAV Class)

Copy events to a new location.

Object Oriented Interface

public function doCopyEvent($sourceresourceuri, $destinationresourceuri);

Procedural Interface

ipworks_caldav_do_copyevent($res, $sourceresourceuri, $destinationresourceuri);

Remarks

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

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

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

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

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

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

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

CreateCalendar Method (IPWorks_CalDAV Class)

Creates a new calendar collection resource.

Object Oriented Interface

public function doCreateCalendar($resourceuri, $displayname, $description);

Procedural Interface

ipworks_caldav_do_createcalendar($res, $resourceuri, $displayname, $description);

Remarks

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

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

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

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

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

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

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

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

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

CreateEvent Method (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function doCreateEvent($resourceuri);

Procedural Interface

ipworks_caldav_do_createevent($res, $resourceuri);

Remarks

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

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

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

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

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

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

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

DeleteCalendar Method (IPWorks_CalDAV Class)

Deletes a calendar collection resource.

Object Oriented Interface

public function doDeleteCalendar($resourceuri);

Procedural Interface

ipworks_caldav_do_deletecalendar($res, $resourceuri);

Remarks

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

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

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

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

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

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

DeleteEvent Method (IPWorks_CalDAV Class)

Delete a resource or collection.

Object Oriented Interface

public function doDeleteEvent($resourceuri);

Procedural Interface

ipworks_caldav_do_deleteevent($res, $resourceuri);

Remarks

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

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

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

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

DoEvents Method (IPWorks_CalDAV Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_caldav_do_doevents($res);

Remarks

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

ExportICS Method (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function doExportICS();

Procedural Interface

ipworks_caldav_do_exportics($res);

Remarks

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

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

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

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

GetCalendarOptions Method (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function doGetCalendarOptions($resourceuri);

Procedural Interface

ipworks_caldav_do_getcalendaroptions($res, $resourceuri);

Remarks

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

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

Since the "DAV" header contains "calendar-access", CalDAV is supported on this ResourceURI.

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

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

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

GetCalendarReport Method (IPWorks_CalDAV Class)

Generates a report on the indicated calendar collection resource.

Object Oriented Interface

public function doGetCalendarReport($resourceuri);

Procedural Interface

ipworks_caldav_do_getcalendarreport($res, $resourceuri);

Remarks

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

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

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

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

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

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

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

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

GetEvent Method (IPWorks_CalDAV Class)

Retrieves a single event from the CalDAV server.

Object Oriented Interface

public function doGetEvent($resourceuri);

Procedural Interface

ipworks_caldav_do_getevent($res, $resourceuri);

Remarks

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

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

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

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

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

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

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

GetFreeBusyReport Method (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function doGetFreeBusyReport($resourceuri);

Procedural Interface

ipworks_caldav_do_getfreebusyreport($res, $resourceuri);

Remarks

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

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

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

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

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

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

ImportICS Method (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function doImportICS($calendardata);

Procedural Interface

ipworks_caldav_do_importics($res, $calendardata);

Remarks

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

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

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

Interrupt Method (IPWorks_CalDAV Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworks_caldav_do_interrupt($res);

Remarks

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

ListCalendars Method (IPWorks_CalDAV Class)

Lists all calendars that the current user can access.

Object Oriented Interface

public function doListCalendars($baseurl);

Procedural Interface

ipworks_caldav_do_listcalendars($res, $baseurl);

Remarks

This method lists all calendars the user can access.

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

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

Once this method returns, the class will populate the Calendar* properties. For example:

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

LockCalendar Method (IPWorks_CalDAV Class)

Obtain a lock for a specified calendar resource.

Object Oriented Interface

public function doLockCalendar($resourceuri);

Procedural Interface

ipworks_caldav_do_lockcalendar($res, $resourceuri);

Remarks

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

After a successful call to the LockCalendar method the class will receive the new lock values, which it will parse and store in the lock properties.

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

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

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

MoveEvent Method (IPWorks_CalDAV Class)

Moves one calendar resource to a new location.

Object Oriented Interface

public function doMoveEvent($sourceresourceuri, $destinationresourceuri);

Procedural Interface

ipworks_caldav_do_moveevent($res, $sourceresourceuri, $destinationresourceuri);

Remarks

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

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

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

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

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

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

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

Reset Method (IPWorks_CalDAV Class)

Reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_caldav_do_reset($res);

Remarks

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

SendCustomRequest Method (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function doSendCustomRequest($httpmethod, $url, $requestbody);

Procedural Interface

ipworks_caldav_do_sendcustomrequest($res, $httpmethod, $url, $requestbody);

Remarks

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

UnLockCalendar Method (IPWorks_CalDAV Class)

Unlocks a calendar resource.

Object Oriented Interface

public function doUnLockCalendar($resourceuri);

Procedural Interface

ipworks_caldav_do_unlockcalendar($res, $resourceuri);

Remarks

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

UpdateCalendar Method (IPWorks_CalDAV Class)

Updates a calendar collection resource.

Object Oriented Interface

public function doUpdateCalendar($resourceuri, $calindex);

Procedural Interface

ipworks_caldav_do_updatecalendar($res, $resourceuri, $calindex);

Remarks

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

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

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

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

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

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

UpdateEvent Method (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function doUpdateEvent($resourceuri);

Procedural Interface

ipworks_caldav_do_updateevent($res, $resourceuri);

Remarks

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

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

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

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

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

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

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

Connected Event (IPWorks_CalDAV Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworks_caldav_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

Remarks

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

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

Please refer to the Error Codes section for more information.

ConnectionStatus Event (IPWorks_CalDAV Class)

Fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworks_caldav_register_callback($res, 2, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

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

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

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

Disconnected Event (IPWorks_CalDAV Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworks_caldav_register_callback($res, 3, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

Remarks

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

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

Please refer to the Error Codes section for more information.

EndTransfer Event (IPWorks_CalDAV Class)

This event is fired when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworks_caldav_register_callback($res, 4, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

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

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

Error Event (IPWorks_CalDAV Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_caldav_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

EventDetails Event (IPWorks_CalDAV Class)

Fires for each calendar event received.

Object Oriented Interface

public function fireEventDetails($param);

Procedural Interface

ipworks_caldav_register_callback($res, 6, array($this, 'fireEventDetails'));

Parameter List

 'resourceuri'
 'responsestatus'
 'etag'
 'calendardata'
 'summary'

Remarks

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

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

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

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

FreeBusy Event (IPWorks_CalDAV Class)

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

Object Oriented Interface

public function fireFreeBusy($param);

Procedural Interface

ipworks_caldav_register_callback($res, 7, array($this, 'fireFreeBusy'));

Parameter List

 'busytype'
 'busyrange'

Remarks

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

Header Event (IPWorks_CalDAV Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

ipworks_caldav_register_callback($res, 8, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

Remarks

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

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

Log Event (IPWorks_CalDAV Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworks_caldav_register_callback($res, 9, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

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

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

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

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

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

Message is the log entry.

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

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

Redirect Event (IPWorks_CalDAV Class)

Fired when a redirection is received from the server.

Object Oriented Interface

public function fireRedirect($param);

Procedural Interface

ipworks_caldav_register_callback($res, 10, array($this, 'fireRedirect'));

Parameter List

 'location'
 'accept'

Remarks

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

SetCookie Event (IPWorks_CalDAV Class)

Fired for every cookie set by the server.

Object Oriented Interface

public function fireSetCookie($param);

Procedural Interface

ipworks_caldav_register_callback($res, 11, array($this, 'fireSetCookie'));

Parameter List

 'name'
 'value'
 'expires'
 'domain'
 'path'
 'secure'

Remarks

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

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

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

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

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

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

SSLServerAuthentication Event (IPWorks_CalDAV Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworks_caldav_register_callback($res, 12, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (IPWorks_CalDAV Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworks_caldav_register_callback($res, 13, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (IPWorks_CalDAV Class)

This event is fired when a document starts transferring (after the headers).

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworks_caldav_register_callback($res, 14, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

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

Status Event (IPWorks_CalDAV Class)

Fired when the HTTP status line is received from the server.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

ipworks_caldav_register_callback($res, 15, array($this, 'fireStatus'));

Parameter List

 'httpversion'
 'statuscode'
 'description'

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

Transfer Event (IPWorks_CalDAV Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworks_caldav_register_callback($res, 16, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

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

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (CalDAV Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

CalDAV Config Settings

WebDAV Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (CalDAV Class)

CalDAV Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors