IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

CalDAV Bean

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

IPWorks.Caldav

Remarks

The bean allows remote management of calendar events and collections of events (the calendar itself), including creation, deletion, listing, copying, and moving. Resource locking is also supported.

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

Single events can be added to a calendar (or updated) using the PutCalendarEvent method, and can be retrieved via the GetCalendarEvent method. Events may be copied or moved with the CopyCalendarEvent and MoveCalendarEvent.

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

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

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

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:

These methods all act upon the calendar collection resource (the calendar itself): 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://www.google.com/calendar/dav/" plus your email address to access the default calendar. So "https://www.google.com/calendar/dav/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://www.google.com/calendar/dav/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example:

  CalDAV.GetCalendarReport("https://www.google.com/calendar/dav/username@gmail.com/events/");
Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the PutCalendarEvent method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the UID property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with GetCalendarEvent. For example:

  CalDAV.UID = "1234567890";
  CalDAV.PutCalendarEvent("https://www.google.com/calendar/dav/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the CreateCalendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions:

  CalDAVS1.User = "username";
  CalDAVS1.Password = "password";
  
  CalDAV.DisplayName = "My Hockey Calendar";
  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
  
  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.PutCalendarEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");
  
  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Property List


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

AlarmsAn alarm related to the event.
AttendeesDefines one or more participants that have been invited to the event.
AuthorizationThe Authorization string to be sent to the server.
AuthSchemeThe authentication scheme to use when server authorization is required.
CategoriesUsed to specify categories or subtypes of the calendar event.
ClassificationDefines the access classification for a calendar component.
CompletedDate and time that a to-do was actually completed.
ConnectedShows whether the component is connected.
CookiesCollection of cookies.
CreatedDate and time calendar information created.
CustomPropertiesList of extra properties that may be used to extend the functionality of this component.
DepthThe depth associated with the current operation.
DescriptionProvides a complete description of the calendar event.
DisplayNameProvides the display name of the calendar being created.
DurationDuration of the calendar event.
EndDateSpecifies the date and time that a calendar event ends.
ETagIdentifier returned by the CalDAV server which is used to synchronize edits.
EventTypeIndicates the type of calendar object resource.
FirewallA set of properties related to firewall access.
FollowRedirectsDetermines what happens when the server issues a redirect.
FreeBusySpecifies the times when the calendar owner is free or busy.
IdleThe current status of the component.
LastModifiedThe date and time that the information associated with the calendar event was last revised in the calendar store.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocationDefines the intended venue for the activity defined by a calendar component.
LockPropertiesFields used when locking and unlocking a calendar resource.
OrganizerDefines the organizer of a calendar event.
OtherHeadersOther headers as determined by the user (optional).
ParsedHeadersCollection of headers returned from the last request.
PasswordA password if authentication is to be used.
PriorityDefines the relative priority for a calendar event.
ProxyA set of properties related to proxy access.
RecurrenceDefines the recurrence set for the event.
ReportFilterCriteria used to filter reports.
SequenceDefines the revision sequence number of the event within a sequence of revisions.
StartDateSpecifies the date and time that an event begins.
StatusDefines the overall status or confirmation for the calendar event.
StatusLineThe first line of the last server response.
SummaryDefines a short summary or subject for the calendar event.
TimeoutA timeout for the component.
TimestampSpecifies the date and time that the instance of the event was created.
TimezoneSpecifies a time zone on a calendar collection.
TransparencyDefines whether or not an event is transparent to busy time searches.
UIDA persistent, globally unique identifier for the calendar event.
URLLocation of the event resource on the CalDAV server.
UserA user name if authentication is to be used.

Method List


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

addCookieAdds a cookie and the corresponding value to the outgoing request headers.
addCustomPropertyAdds a form variable and the corresponding value.
configSets or retrieves a configuration setting .
copyCalendarEventCopy events to a new location.
createCalendarCreates a new calendar collection resource.
deleteCalendarEventDelete a resource or collection.
doEventsProcesses events from the internal message queue.
exportICSGenerates an event from the properties in the iCal (.ICS) format.
getCalendarEventRetrieves a single event from the CalDAV server.
getCalendarOptionsRetrieves options for the ResourceURI to determines whether it supports calendar access.
getCalendarReportGenerates a report on the indicated calendar collection resource.
getFreeBusyReportGenerates a report as to when the calendar owner is free and/or busy.
importICSImports iCal data (contained in an ICS file) into the component's property list.
interruptInterrupt the current method.
lockCalendarObtain a lock for a specified calendar resource.
moveCalendarEventMoves one calendar resource to a new location.
putCalendarEventAdds a calendar resource at the specified ResourceURI using the CalDAV PUT method.
resetReset the component.
unLockCalendarUnlocks a calendar resource.

Event List


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

ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in connection state.
DisconnectedFired when a connection is closed.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
EventDetailsFires for each calendar event received.
FreeBusyFires for each Free/Busy element received in the response.
HeaderFired every time a header line comes in.
RedirectFired when a redirection is received from the server.
SetCookieFired for every cookie set by the server.
StartTransferFired when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TransferFired while a document transfers (delivers document).

Configuration Settings


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

AuthSchemeThe authentication scheme to use for server authorization.
BuildEventBuilds the current event for a multi-event calendar entry.
DueDateSpecifies the due date for a calendar event.
EndCalendarSignifies the end of a multi-event calendar entry.
ExpandRecurringEventsInstructs the component to return all instances of a recurring event within a timeframe.
ProductIdSpecifies the identifier for the product that created the iCalendar object.
RecurrenceExceptionDatesAttrsSpecifies the attributes for the exception dates of a recurring event.
StartCalendarSignifies the beginning of a multi-event calendar entry.
EncodeURLIf set to true the URL will be encoded by the component.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0