CalDAV Module

Properties   Methods   Events   Config Settings   Errors  

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

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

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

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

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

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

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

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

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

• CopyCalendarEvent
• DeleteCalendarEvent
• MoveCalendarEvent
• GetCalendarEvent
• PutCalendarEvent

• CreateCalendar
• GetCalendarOptions
• GetCalendarReport
• GetFreeBusyReport

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

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

Alarms Property (CalDAV Module)

An alarm related to the event.

Syntax

• Swift
• Objective-C

public var alarms: Array<CalAlarm> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=alarmCount,setter=setAlarmCount:) int alarmCount;

- (int)alarmCount;
- (void)setAlarmCount :(int)newAlarmCount;

- (int)alarmAction:(int)alarmIndex;
- (void)setAlarmAction:(int)alarmIndex :(int)newAlarmAction;

- (NSString*)alarmAttachment:(int)alarmIndex;
- (void)setAlarmAttachment:(int)alarmIndex :(NSString*)newAlarmAttachment;

- (NSString*)alarmAttachmentType:(int)alarmIndex;
- (void)setAlarmAttachmentType:(int)alarmIndex :(NSString*)newAlarmAttachmentType;

- (NSString*)alarmDuration:(int)alarmIndex;
- (void)setAlarmDuration:(int)alarmIndex :(NSString*)newAlarmDuration;

- (NSString*)alarmMessage:(int)alarmIndex;
- (void)setAlarmMessage:(int)alarmIndex :(NSString*)newAlarmMessage;

- (NSString*)alarmRecipient:(int)alarmIndex;
- (void)setAlarmRecipient:(int)alarmIndex :(NSString*)newAlarmRecipient;

- (int)alarmRepeat:(int)alarmIndex;
- (void)setAlarmRepeat:(int)alarmIndex :(int)newAlarmRepeat;

- (NSString*)alarmSubject:(int)alarmIndex;
- (void)setAlarmSubject:(int)alarmIndex :(NSString*)newAlarmSubject;

- (NSString*)alarmTrigger:(int)alarmIndex;
- (void)setAlarmTrigger:(int)alarmIndex :(NSString*)newAlarmTrigger;

Default Value

""

Remarks

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

Each CalAlarm calendar component MUST include the and properties. The property further constrains the CalAlarm in the following ways:

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

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

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

An event may contain multiple alarms.

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

Attendees Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var attendees: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=attendees,setter=setAttendees:) NSString* attendees;

- (NSString*)attendees;
- (void)setAttendees :(NSString*)newAttendees;

Default Value

""

Remarks

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

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

Authorization Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var authorization: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=authorization,setter=setAuthorization:) NSString* authorization;

- (NSString*)authorization;
- (void)setAuthorization :(NSString*)newAuthorization;

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]".

AuthScheme Property (CalDAV Module)

The authentication scheme to use when server authentication is required.

Syntax

• Swift
• Objective-C

public var authScheme: CaldavAuthSchemes {
  get {...}
  set {...}
}

public enum CaldavAuthSchemes: Int32 {
  case authBasic = 0
  case authDigest = 1
  case authProprietary = 2
  case authNone = 3
  case authNtlm = 4
  case authNegotiate = 5
  case authOAuth = 6
}

@property (nonatomic,readwrite,assign,getter=authScheme,setter=setAuthScheme:) int authScheme;

- (int)authScheme;
- (void)setAuthScheme :(int)newAuthScheme;

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.

Categories Property (CalDAV Module)

Used to specify categories or subtypes of the calendar event.

Syntax

• Swift
• Objective-C

public var categories: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=categories,setter=setCategories:) NSString* categories;

- (NSString*)categories;
- (void)setCategories :(NSString*)newCategories;

Default Value

""

Remarks

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

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

Classification Property (CalDAV Module)

Defines the access classification for a calendar module.

Syntax

• Swift
• Objective-C

public var classification: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=classification,setter=setClassification:) NSString* classification;

- (NSString*)classification;
- (void)setClassification :(NSString*)newClassification;

Default Value

""

Remarks

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

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

Completed Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var completed: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=completed,setter=setCompleted:) NSString* completed;

- (NSString*)completed;
- (void)setCompleted :(NSString*)newCompleted;

Default Value

""

Remarks

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

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

Connected Property (CalDAV Module)

This shows whether the module is connected.

Syntax

• Swift
• Objective-C

public var connected: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=connected,setter=setConnected:) BOOL connected;

- (BOOL)connected;
- (void)setConnected :(BOOL)newConnected;

Default Value

False

Remarks

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

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

Cookies Property (CalDAV Module)

This property includes a collection of cookies.

Syntax

• Swift
• Objective-C

public var cookies: Array<HTTPCookie> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=cookieCount,setter=setCookieCount:) int cookieCount;

- (int)cookieCount;
- (void)setCookieCount :(int)newCookieCount;

- (NSString*)cookieDomain:(int)cookieIndex;

- (NSString*)cookieExpiration:(int)cookieIndex;

- (NSString*)cookieName:(int)cookieIndex;
- (void)setCookieName:(int)cookieIndex :(NSString*)newCookieName;

- (NSString*)cookiePath:(int)cookieIndex;

- (BOOL)cookieSecure:(int)cookieIndex;

- (NSString*)cookieValue:(int)cookieIndex;
- (void)setCookieValue:(int)cookieIndex :(NSString*)newCookieValue;

Default Value

""

Remarks

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

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

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

Created Property (CalDAV Module)

Date and time calendar information created.

Syntax

• Swift
• Objective-C

public var created: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=created,setter=setCreated:) NSString* created;

- (NSString*)created;
- (void)setCreated :(NSString*)newCreated;

Default Value

""

Remarks

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

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

CustomProperties Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var customProperties: Array<CalCustomProp> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=customPropertyCount,setter=setCustomPropertyCount:) int customPropertyCount;

- (int)customPropertyCount;
- (void)setCustomPropertyCount :(int)newCustomPropertyCount;

- (NSString*)customPropertyAttribute:(int)customPropertyIndex;
- (void)setCustomPropertyAttribute:(int)customPropertyIndex :(NSString*)newCustomPropertyAttribute;

- (NSString*)customPropertyName:(int)customPropertyIndex;
- (void)setCustomPropertyName:(int)customPropertyIndex :(NSString*)newCustomPropertyName;

- (NSString*)customPropertyValue:(int)customPropertyIndex;
- (void)setCustomPropertyValue:(int)customPropertyIndex :(NSString*)newCustomPropertyValue;

Default Value

""

Remarks

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

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

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

Depth Property (CalDAV Module)

The depth associated with the current operation.

Syntax

• Swift
• Objective-C

public var depth: CaldavDepths {
  get {...}
  set {...}
}

public enum CaldavDepths: Int32 {
  case dpUnspecified = 0
  case dpResourceOnly = 1
  case dpImmediateChildren = 2
  case dpInfinity = 3
}

@property (nonatomic,readwrite,assign,getter=depth,setter=setDepth:) int depth;

- (int)depth;
- (void)setDepth :(int)newDepth;

Default Value

0

Remarks

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

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

Description Property (CalDAV Module)

Provides a complete description of the calendar event.

Syntax

• Swift
• Objective-C

public var description_: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=description,setter=setDescription:) NSString* description;

- (NSString*)description;
- (NSString*)description_;
- (void)setDescription :(NSString*)newDescription;
- (void)setDescription_ :(NSString*)newDescription;

Default Value

""

Remarks

This property provides a more complete description of the event than is provided by the Summary property. It is also used by the CreateCalendar method when creating a new calendar collection.

DisplayName Property (CalDAV Module)

Provides the display name of the calendar being created.

Syntax

• Swift
• Objective-C

public var displayName: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=displayName,setter=setDisplayName:) NSString* displayName;

- (NSString*)displayName;
- (void)setDisplayName :(NSString*)newDisplayName;

Default Value

""

Remarks

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

DueDate Property (CalDAV Module)

Specifies the due date for a calendar event.

Syntax

• Swift
• Objective-C

public var dueDate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=dueDate,setter=setDueDate:) NSString* dueDate;

- (NSString*)dueDate;
- (void)setDueDate :(NSString*)newDueDate;

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.

Duration Property (CalDAV Module)

Duration of the calendar event.

Syntax

• Swift
• Objective-C

public var duration: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=duration,setter=setDuration:) NSString* duration;

- (NSString*)duration;
- (void)setDuration :(NSString*)newDuration;

Default Value

""

Remarks

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

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

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

EndDate Property (CalDAV Module)

Specifies the date and time that a calendar event ends.

Syntax

• Swift
• Objective-C

public var endDate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=endDate,setter=setEndDate:) NSString* endDate;

- (NSString*)endDate;
- (void)setEndDate :(NSString*)newEndDate;

Default Value

""

Remarks

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

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

ETag Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var eTag: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=ETag,setter=setETag:) NSString* ETag;

- (NSString*)ETag;
- (void)setETag :(NSString*)newETag;

Default Value

""

Remarks

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

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

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

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

EventType Property (CalDAV Module)

Indicates the type of calendar object resource.

Syntax

• Swift
• Objective-C

public var eventType: CaldavEventTypes {
  get {...}
  set {...}
}

public enum CaldavEventTypes: Int32 {
  case vEvent = 0
  case vTodo = 1
  case vJournal = 2
  case vFreeBusy = 3
}

@property (nonatomic,readwrite,assign,getter=eventType,setter=setEventType:) int eventType;

- (int)eventType;
- (void)setEventType :(int)newEventType;

Default Value

0

Remarks

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

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

Firewall Property (CalDAV Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

""

Remarks

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

FollowRedirects Property (CalDAV Module)

This property determines what happens when the server issues a redirect.

Syntax

• Swift
• Objective-C

public var followRedirects: CaldavFollowRedirects {
  get {...}
  set {...}
}

public enum CaldavFollowRedirects: Int32 {
  case frNever = 0
  case frAlways = 1
  case frSameScheme = 2
}

@property (nonatomic,readwrite,assign,getter=followRedirects,setter=setFollowRedirects:) int followRedirects;

- (int)followRedirects;
- (void)setFollowRedirects :(int)newFollowRedirects;

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 .

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

FreeBusy Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var freeBusy: Array<CalFreeBusy> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=freeBusyCount) int freeBusyCount;

- (int)freeBusyCount;

- (NSString*)freeBusyRange:(int)freeBusyIndex;

- (NSString*)freeBusyType:(int)freeBusyIndex;

Default Value

""

Remarks

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

Idle Property (CalDAV Module)

The current status of the module.

Syntax

• Swift
• Objective-C

public var idle: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=idle) BOOL idle;

- (BOOL)idle;

Default Value

True

Remarks

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

This property is read-only.

LastModified Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var lastModified: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=lastModified,setter=setLastModified:) NSString* lastModified;

- (NSString*)lastModified;
- (void)setLastModified :(NSString*)newLastModified;

Default Value

""

Remarks

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

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

LocalHost Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

Default Value

""

Remarks

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

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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

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

Location Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var location: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=location,setter=setLocation:) NSString* location;

- (NSString*)location;
- (void)setLocation :(NSString*)newLocation;

Default Value

""

Remarks

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

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

LockProperties Property (CalDAV Module)

Fields used when locking and unlocking a calendar resource.

Syntax

• Swift
• Objective-C

public var lockProperties: CalLock {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=lockType,setter=setLockType:) NSString* lockType;

- (NSString*)lockType;
- (void)setLockType :(NSString*)newLockType;

@property (nonatomic,readwrite,assign,getter=lockOwner,setter=setLockOwner:) NSString* lockOwner;

- (NSString*)lockOwner;
- (void)setLockOwner :(NSString*)newLockOwner;

@property (nonatomic,readwrite,assign,getter=lockScope,setter=setLockScope:) NSString* lockScope;

- (NSString*)lockScope;
- (void)setLockScope :(NSString*)newLockScope;

@property (nonatomic,readwrite,assign,getter=lockTimeout,setter=setLockTimeout:) int lockTimeout;

- (int)lockTimeout;
- (void)setLockTimeout :(int)newLockTimeout;

@property (nonatomic,readwrite,assign,getter=lockTokens,setter=setLockTokens:) NSString* lockTokens;

- (NSString*)lockTokens;
- (void)setLockTokens :(NSString*)newLockTokens;

 

Default Value

""

Remarks

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

Organizer Property (CalDAV Module)

Defines the organizer of a calendar event.

Syntax

• Swift
• Objective-C

public var organizer: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=organizer,setter=setOrganizer:) NSString* organizer;

- (NSString*)organizer;
- (void)setOrganizer :(NSString*)newOrganizer;

Default Value

""

Remarks

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

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

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

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

OtherHeaders Property (CalDAV Module)

This property includes other headers as determined by the user (optional).

Syntax

• Swift
• Objective-C

public var otherHeaders: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=otherHeaders,setter=setOtherHeaders:) NSString* otherHeaders;

- (NSString*)otherHeaders;
- (void)setOtherHeaders :(NSString*)newOtherHeaders;

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 .

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

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

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

ParsedHeaders Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var parsedHeaders: Array<Header> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=parsedHeaderCount) int parsedHeaderCount;

- (int)parsedHeaderCount;

- (NSString*)parsedHeaderField:(int)parsedHeaderIndex;

- (NSString*)parsedHeaderValue:(int)parsedHeaderIndex;

Default Value

""

Remarks

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

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

Password Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var password: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

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.

Priority Property (CalDAV Module)

Defines the relative priority for a calendar event.

Syntax

• Swift
• Objective-C

public var priority: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=priority,setter=setPriority:) int priority;

- (int)priority;
- (void)setPriority :(int)newPriority;

Default Value

0

Remarks

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

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

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

Proxy Property (CalDAV Module)

A set of properties related to proxy access.

Syntax

• Swift
• Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

 

Default Value

""

Remarks

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

Recurrence Property (CalDAV Module)

Defines the recurrence set for the event.

Syntax

• Swift
• Objective-C

public var recurrence: CalRecurrence {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=recurrenceDates,setter=setRecurrenceDates:) NSString* recurrenceDates;

- (NSString*)recurrenceDates;
- (void)setRecurrenceDates :(NSString*)newRecurrenceDates;

@property (nonatomic,readwrite,assign,getter=recurrenceExceptionDates,setter=setRecurrenceExceptionDates:) NSString* recurrenceExceptionDates;

- (NSString*)recurrenceExceptionDates;
- (void)setRecurrenceExceptionDates :(NSString*)newRecurrenceExceptionDates;

@property (nonatomic,readwrite,assign,getter=recurrenceExceptionRule,setter=setRecurrenceExceptionRule:) NSString* recurrenceExceptionRule;

- (NSString*)recurrenceExceptionRule;
- (void)setRecurrenceExceptionRule :(NSString*)newRecurrenceExceptionRule;

@property (nonatomic,readwrite,assign,getter=recurrenceId,setter=setRecurrenceId:) NSString* recurrenceId;

- (NSString*)recurrenceId;
- (void)setRecurrenceId :(NSString*)newRecurrenceId;

@property (nonatomic,readwrite,assign,getter=recurrenceRule,setter=setRecurrenceRule:) NSString* recurrenceRule;

- (NSString*)recurrenceRule;
- (void)setRecurrenceRule :(NSString*)newRecurrenceRule;

 

Default Value

""

Remarks

This property defines the recurrence set for the event. The recurrence set is the complete set of recurrence instances for a calendar component. The recurrence set is generated by considering the initial StartDate property along with the , , , and 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 and properties, and then excluding any start DATE-TIME values specified by the or properties. This implies that DATE-TIME values specified by the and properties take precedence over those specified by inclusion properties (i.e., and ). When duplicate instances are generated by the recurrence and properties, only one recurrence is considered. Duplicate instances are ignored.

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

ReportFilter Property (CalDAV Module)

Criteria used to filter reports.

Syntax

• Swift
• Objective-C

public var reportFilter: CalReportFilter {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=reportFilterAlarmEnd,setter=setReportFilterAlarmEnd:) NSString* reportFilterAlarmEnd;

- (NSString*)reportFilterAlarmEnd;
- (void)setReportFilterAlarmEnd :(NSString*)newReportFilterAlarmEnd;

@property (nonatomic,readwrite,assign,getter=reportFilterAlarmStart,setter=setReportFilterAlarmStart:) NSString* reportFilterAlarmStart;

- (NSString*)reportFilterAlarmStart;
- (void)setReportFilterAlarmStart :(NSString*)newReportFilterAlarmStart;

@property (nonatomic,readwrite,assign,getter=reportFilterCustomFilter,setter=setReportFilterCustomFilter:) NSString* reportFilterCustomFilter;

- (NSString*)reportFilterCustomFilter;
- (void)setReportFilterCustomFilter :(NSString*)newReportFilterCustomFilter;

@property (nonatomic,readwrite,assign,getter=reportFilterEndDate,setter=setReportFilterEndDate:) NSString* reportFilterEndDate;

- (NSString*)reportFilterEndDate;
- (void)setReportFilterEndDate :(NSString*)newReportFilterEndDate;

@property (nonatomic,readwrite,assign,getter=reportFilterEventType,setter=setReportFilterEventType:) int reportFilterEventType;

- (int)reportFilterEventType;
- (void)setReportFilterEventType :(int)newReportFilterEventType;

@property (nonatomic,readwrite,assign,getter=reportFilterProperty,setter=setReportFilterProperty:) NSString* reportFilterProperty;

- (NSString*)reportFilterProperty;
- (void)setReportFilterProperty :(NSString*)newReportFilterProperty;

@property (nonatomic,readwrite,assign,getter=reportFilterRecurEnd,setter=setReportFilterRecurEnd:) NSString* reportFilterRecurEnd;

- (NSString*)reportFilterRecurEnd;
- (void)setReportFilterRecurEnd :(NSString*)newReportFilterRecurEnd;

@property (nonatomic,readwrite,assign,getter=reportFilterRecurStart,setter=setReportFilterRecurStart:) NSString* reportFilterRecurStart;

- (NSString*)reportFilterRecurStart;
- (void)setReportFilterRecurStart :(NSString*)newReportFilterRecurStart;

@property (nonatomic,readwrite,assign,getter=reportFilterReturnCalendarData,setter=setReportFilterReturnCalendarData:) BOOL reportFilterReturnCalendarData;

- (BOOL)reportFilterReturnCalendarData;
- (void)setReportFilterReturnCalendarData :(BOOL)newReportFilterReturnCalendarData;

@property (nonatomic,readwrite,assign,getter=reportFilterStartDate,setter=setReportFilterStartDate:) NSString* reportFilterStartDate;

- (NSString*)reportFilterStartDate;
- (void)setReportFilterStartDate :(NSString*)newReportFilterStartDate;

@property (nonatomic,readwrite,assign,getter=reportFilterUID,setter=setReportFilterUID:) NSString* reportFilterUID;

- (NSString*)reportFilterUID;
- (void)setReportFilterUID :(NSString*)newReportFilterUID;

 

Default Value

""

Remarks

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

Sequence Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var sequence: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=sequence,setter=setSequence:) int sequence;

- (int)sequence;
- (void)setSequence :(int)newSequence;

Default Value

0

Remarks

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

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

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

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

SSLAcceptServerCertEncoded Property (CalDAV Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslAcceptServerCertEncoded: String {
  get {...}
  set {...}
}

public var sslAcceptServerCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

Default Value

""

Remarks

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (CalDAV Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

Default Value

""

Remarks

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

SSLCertStorePassword Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

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.

SSLCertStoreType Property (CalDAV Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var sslCertStoreType: CaldavSSLCertStoreTypes {
  get {...}
  set {...}
}

public enum CaldavSSLCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstPKCS11 = 23
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

SSLCertSubject Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var sslCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

Default Value

""

Remarks

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

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

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

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

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

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

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (CalDAV Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

public var sslProvider: CaldavSSLProviders {
  get {...}
  set {...}
}

public enum CaldavSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

Default Value

0

Remarks

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

Possible values are:

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

When Automatic is selected the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (CalDAV Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

Default Value

""

Remarks

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

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

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

StartDate Property (CalDAV Module)

Specifies the date and time that an event begins.

Syntax

• Swift
• Objective-C

public var startDate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=startDate,setter=setStartDate:) NSString* startDate;

- (NSString*)startDate;
- (void)setStartDate :(NSString*)newStartDate;

Default Value

""

Remarks

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

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

Status Property (CalDAV Module)

Defines the overall status or confirmation for the calendar event.

Syntax

• Swift
• Objective-C

public var status: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=status,setter=setStatus:) NSString* status;

- (NSString*)status;
- (void)setStatus :(NSString*)newStatus;

Default Value

""

Remarks

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

Statuses for a vEvent EventType:

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

StatusLine Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var statusLine: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=statusLine) NSString* statusLine;

- (NSString*)statusLine;

Default Value

""

Remarks

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

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

This property is read-only.

Summary Property (CalDAV Module)

Defines a short summary or subject for the calendar event.

Syntax

• Swift
• Objective-C

public var summary: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=summary,setter=setSummary:) NSString* summary;

- (NSString*)summary;
- (void)setSummary :(NSString*)newSummary;

Default Value

""

Remarks

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

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

Timeout Property (CalDAV Module)

A timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

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 .

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Timestamp Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var timestamp: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timestamp,setter=setTimestamp:) NSString* timestamp;

- (NSString*)timestamp;
- (void)setTimestamp :(NSString*)newTimestamp;

Default Value

""

Remarks

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

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

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

Timezone Property (CalDAV Module)

Specifies a time zone on a calendar collection.

Syntax

• Swift
• Objective-C

public var timezone: CalTimezone {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timezoneDSTName,setter=setTimezoneDSTName:) NSString* timezoneDSTName;

- (NSString*)timezoneDSTName;
- (void)setTimezoneDSTName :(NSString*)newTimezoneDSTName;

@property (nonatomic,readwrite,assign,getter=timezoneDSTOffsetFrom,setter=setTimezoneDSTOffsetFrom:) NSString* timezoneDSTOffsetFrom;

- (NSString*)timezoneDSTOffsetFrom;
- (void)setTimezoneDSTOffsetFrom :(NSString*)newTimezoneDSTOffsetFrom;

@property (nonatomic,readwrite,assign,getter=timezoneDSTOffsetTo,setter=setTimezoneDSTOffsetTo:) NSString* timezoneDSTOffsetTo;

- (NSString*)timezoneDSTOffsetTo;
- (void)setTimezoneDSTOffsetTo :(NSString*)newTimezoneDSTOffsetTo;

@property (nonatomic,readwrite,assign,getter=timezoneDSTRule,setter=setTimezoneDSTRule:) NSString* timezoneDSTRule;

- (NSString*)timezoneDSTRule;
- (void)setTimezoneDSTRule :(NSString*)newTimezoneDSTRule;

@property (nonatomic,readwrite,assign,getter=timezoneDSTStart,setter=setTimezoneDSTStart:) NSString* timezoneDSTStart;

- (NSString*)timezoneDSTStart;
- (void)setTimezoneDSTStart :(NSString*)newTimezoneDSTStart;

@property (nonatomic,readwrite,assign,getter=timezoneLastModified,setter=setTimezoneLastModified:) NSString* timezoneLastModified;

- (NSString*)timezoneLastModified;
- (void)setTimezoneLastModified :(NSString*)newTimezoneLastModified;

@property (nonatomic,readwrite,assign,getter=timezoneStdName,setter=setTimezoneStdName:) NSString* timezoneStdName;

- (NSString*)timezoneStdName;
- (void)setTimezoneStdName :(NSString*)newTimezoneStdName;

@property (nonatomic,readwrite,assign,getter=timezoneStdOffsetFrom,setter=setTimezoneStdOffsetFrom:) NSString* timezoneStdOffsetFrom;

- (NSString*)timezoneStdOffsetFrom;
- (void)setTimezoneStdOffsetFrom :(NSString*)newTimezoneStdOffsetFrom;

@property (nonatomic,readwrite,assign,getter=timezoneStdOffsetTo,setter=setTimezoneStdOffsetTo:) NSString* timezoneStdOffsetTo;

- (NSString*)timezoneStdOffsetTo;
- (void)setTimezoneStdOffsetTo :(NSString*)newTimezoneStdOffsetTo;

@property (nonatomic,readwrite,assign,getter=timezoneStdRule,setter=setTimezoneStdRule:) NSString* timezoneStdRule;

- (NSString*)timezoneStdRule;
- (void)setTimezoneStdRule :(NSString*)newTimezoneStdRule;

@property (nonatomic,readwrite,assign,getter=timezoneStdStart,setter=setTimezoneStdStart:) NSString* timezoneStdStart;

- (NSString*)timezoneStdStart;
- (void)setTimezoneStdStart :(NSString*)newTimezoneStdStart;

@property (nonatomic,readwrite,assign,getter=timezoneId,setter=setTimezoneId:) NSString* timezoneId;

- (NSString*)timezoneId;
- (void)setTimezoneId :(NSString*)newTimezoneId;

@property (nonatomic,readwrite,assign,getter=timezoneURL,setter=setTimezoneURL:) NSString* timezoneURL;

- (NSString*)timezoneURL;
- (void)setTimezoneURL :(NSString*)newTimezoneURL;

 

Default Value

""

Remarks

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

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

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

Transparency Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var transparency: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=transparency,setter=setTransparency:) NSString* transparency;

- (NSString*)transparency;
- (void)setTransparency :(NSString*)newTransparency;

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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

UID Property (CalDAV Module)

A persistent, globally unique identifier for the calendar event.

Syntax

• Swift
• Objective-C

public var uid: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=UID,setter=setUID:) NSString* UID;

- (NSString*)UID;
- (void)setUID :(NSString*)newUID;

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 PutCalendarEvent 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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

URL Property (CalDAV Module)

Location of the event resource on the CalDAV server.

Syntax

• Swift
• Objective-C

public var url: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=URL) NSString* URL;

- (NSString*)URL;

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 GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

This property is read-only.

User Property (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public var user: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=user,setter=setUser:) NSString* user;

- (NSString*)user;
- (void)setUser :(NSString*)newUser;

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.

AddCookie Method (CalDAV Module)

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

• Swift
• Objective-C

public func addCookie(cookieName: String, cookieValue: String) throws -> Void

- (void)addCookie:(NSString*)cookieName :(NSString*)cookieValue;

Remarks

This property 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 (CalDAV Module)

Adds a form variable and the corresponding value.

Syntax

• Swift
• Objective-C

public func addCustomProperty(varName: String, varValue: String) throws -> Void

- (void)addCustomProperty:(NSString*)varName :(NSString*)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:

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

Config Method (CalDAV Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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.

CopyCalendarEvent Method (CalDAV Module)

Copy events to a new location.

Syntax

• Swift
• Objective-C

public func copyCalendarEvent(sourceResourceURI: String, destinationResourceURI: String) throws -> Void

- (void)copyCalendarEvent:(NSString*)sourceResourceURI :(NSString*)destinationResourceURI;

Remarks

The CopyCalendarEvent 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://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/");

CreateCalendar Method (CalDAV Module)

Creates a new calendar collection resource.

Syntax

• Swift
• Objective-C

public func createCalendar(resourceURI: String) throws -> Void

- (void)createCalendar:(NSString*)resourceURI;

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 following properties are used to create a new calendar collection resource:

• Description
• DisplayName
• Timezone

The following example shows how to create a simple new calendar collection resource with Yahoo Calendar. CalDAVS1.DisplayName = "Testing Create Calendar method"; CalDAVS1.Description = "Test Calendar"; CalDAVS1.CreateCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1");

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://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/");

DeleteCalendarEvent Method (CalDAV Module)

Delete a resource or collection.

Syntax

• Swift
• Objective-C

public func deleteCalendarEvent(resourceURI: String) throws -> Void

- (void)deleteCalendarEvent:(NSString*)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://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/");

DoEvents Method (CalDAV Module)

Processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

- (void)doEvents;

Remarks

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

ExportICS Method (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public func exportICS() throws -> String

- (NSString*)exportICS;

Remarks

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

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

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

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

GetCalendarEvent Method (CalDAV Module)

Retrieves a single event from the CalDAV server.

Syntax

• Swift
• Objective-C

public func getCalendarEvent(resourceURI: String) throws -> Void

- (void)getCalendarEvent:(NSString*)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 fetched 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 PutCalendarEvent to update the calendar event resource.

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

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

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/");

GetCalendarOptions Method (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public func getCalendarOptions(resourceURI: String) throws -> Void

- (void)getCalendarOptions:(NSString*)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:

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/");

GetCalendarReport Method (CalDAV Module)

Generates a report on the indicated calendar collection resource.

Syntax

• Swift
• Objective-C

public func getCalendarReport(resourceURI: String) throws -> Void

- (void)getCalendarReport:(NSString*)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 PutCalendarEvent or ExportICS, and will be filled after calling GetCalendarEvent or ImportICS. These will also be available from inside the EventDetails event, which is fired for each event received from the CalDAV server in response to a GetCalendarReport.

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

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, STATUS As String, ETag As String, CalendarData As String) Debug.Print CalDAV.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://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/");

GetFreeBusyReport Method (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public func getFreeBusyReport(resourceURI: String) throws -> Void

- (void)getFreeBusyReport:(NSString*)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://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/");

ImportICS Method (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public func importICS(calendarData: String) throws -> Void

- (void)importICS:(NSString*)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 PutCalendarEvent. If you edit any of the class properties between importing and calling PutCalendarEvent, the class will re-generate the PUT request itself. If no properties are changed, the imported data will be submitted unaltered when calling PutCalendarEvent.

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 (CalDAV Module)

Interrupt the current method.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

LockCalendar Method (CalDAV Module)

Obtain a lock for a specified calendar resource.

Syntax

• Swift
• Objective-C

public func lockCalendar(resourceURI: String) throws -> Void

- (void)lockCalendar:(NSString*)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:

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 MoveCalendarEvent or CopyCalendarEvent 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.

MoveCalendarEvent Method (CalDAV Module)

Moves one calendar resource to a new location.

Syntax

• Swift
• Objective-C

public func moveCalendarEvent(sourceResourceURI: String, destinationResourceURI: String) throws -> Void

- (void)moveCalendarEvent:(NSString*)sourceResourceURI :(NSString*)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://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/");

PutCalendarEvent Method (CalDAV Module)

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

Syntax

• Swift
• Objective-C

public func putCalendarEvent(resourceURI: String) throws -> Void

- (void)putCalendarEvent:(NSString*)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 PutCalendarEvent 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 PutCalendarEvent or ExportICS, and will be filled after calling GetCalendarEvent or ImportICS. These will also be available from inside the EventDetails event, which is fired for each event received from the CalDAV server in response to a GetCalendarReport.

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

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/");

Reset Method (CalDAV Module)

Reset the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

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

UnLockCalendar Method (CalDAV Module)

Unlocks a calendar resource.

Syntax

• Swift
• Objective-C

public func unLockCalendar(resourceURI: String) throws -> Void

- (void)unLockCalendar:(NSString*)resourceURI;

Remarks

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

Connected Event (CalDAV Module)

This event is fired immediately after a connection completes (or fails).

Syntax

• Swift
• Objective-C

func onConnected(statusCode: Int32, description: String)

- (void)onConnected:(int)statusCode :(NSString*)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 (CalDAV Module)

This event is fired to indicate changes in the connection state.

Syntax

• Swift
• Objective-C

func onConnectionStatus(connectionEvent: String, statusCode: Int32, description: String)

- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)description;

Remarks

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

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

Disconnected Event (CalDAV Module)

This event is fired when a connection is closed.

Syntax

• Swift
• Objective-C

func onDisconnected(statusCode: Int32, description: String)

- (void)onDisconnected:(int)statusCode :(NSString*)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 (CalDAV Module)

Fired when a document finishes transferring.

Syntax

• Swift
• Objective-C

func onEndTransfer(direction: Int32)

- (void)onEndTransfer:(int)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 (CalDAV Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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

EventDetails Event (CalDAV Module)

Fires for each calendar event received.

Syntax

• Swift
• Objective-C

func onEventDetails(resourceURI: String, responseStatus: String, eTag: String, calendarData: String)

- (void)onEventDetails:(NSString*)resourceURI :(NSString*)responseStatus :(NSString*)ETag :(NSString*)calendarData;

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.

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

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 (CalDAV Module)

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

Syntax

• Swift
• Objective-C

func onFreeBusy(busyType: String, busyRange: String)

- (void)onFreeBusy:(NSString*)busyType :(NSString*)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 (CalDAV Module)

This event is fired every time a header line comes in.

Syntax

• Swift
• Objective-C

func onHeader(field: String, value: String)

- (void)onHeader:(NSString*)field :(NSString*)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 (CalDAV Module)

This event fires once for each log message.

Syntax

• Swift
• Objective-C

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

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

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

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

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

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

Message is the log entry.

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

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

Redirect Event (CalDAV Module)

This event is fired when a redirection is received from the server.

Syntax

• Swift
• Objective-C

func onRedirect(location: String, accept: inout Bool)

- (void)onRedirect:(NSString*)location :(int*)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 . Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (CalDAV Module)

This event is fired for every cookie set by the server.

Syntax

• Swift
• Objective-C

func onSetCookie(name: String, value: String, expires: String, domain: String, path: String, secure: Bool)

- (void)onSetCookie:(NSString*)name :(NSString*)value :(NSString*)expires :(NSString*)domain :(NSString*)path :(BOOL)secure;

Remarks

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

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

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

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

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

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

SSLServerAuthentication Event (CalDAV Module)

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)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 (CalDAV Module)

Fired when secure connection progress messages are available.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

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

StartTransfer Event (CalDAV Module)

Fired when a document starts transferring (after the headers).

Syntax

• Swift
• Objective-C

func onStartTransfer(direction: Int32)

- (void)onStartTransfer:(int)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 (CalDAV Module)

This event is fired when the HTTP status line is received from the server.

Syntax

• Swift
• Objective-C

func onStatus(httpVersion: String, statusCode: Int32, description: String)

- (void)onStatus:(NSString*)HTTPVersion :(int)statusCode :(NSString*)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 (CalDAV Module)

This event is fired while a document transfers (delivers document).

Syntax

• Swift
• Objective-C

func onTransfer(direction: Int32, bytesTransferred: Int64, percentDone: Int32, text: Data)

- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)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.

CalAlarm Type

An alarm related to a calendar event.

Remarks

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

The CalAlarm calendar component MUST include the and propertys. The property further constrains the CalAlarm in the following ways:

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

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

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

Fields

Constructors

public init()

public init(trigger: , action: )

CalCustomProp Type

Name/Value pair of custom properties to add to the request.

Remarks

This type describes a form variable that is to be posted to the Resource URI when Putting an event or creating a new calendar. The type contains fields which describe this variable's name, value, and attribute.

Fields

Constructors

public init()

public init(name: , value: )

public init(name: , value: , attribute: )

CalFreeBusy Type

Describes a single free/busy element in the calendar event.

Remarks

This type describes a FREEBUSY element contained in the calendar data. Each FREEBUSY element will contain a (BUSY, FREE, BUSY-TENTATIVE, etc.) and a , which describes the date and time range for the FREEBUSY element.

Fields

Constructors

public init()

CalLock Type

Group of fields used when locking and unlocking a calendar resource.

Remarks

, , , and are used when locking and unlocking a calendar resource. You may lock the whole calendar, or only a single event within the calendar, depending on the URI you use when locking. After a successful LockCalendar operation, the class will set all of these properties to the values returned in the server's response. The lock are then passed along when copying or moving a calendar event.

Fields

Constructors

public init()

CalRecurrence Type

Defines the recurrence set for an event.

Remarks

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

Fields

Constructors

public init()

CalReportFilter Type

Used to restrict the results of a Report returned from the CalDAV server.

Remarks

You can restrict results to only events within a specified time range (using and ), to only recurring events within a specified time range (using and ), and to events with an alarm set to go off within a specified time range. (using and ). You can also restrict results to only those events which contain a specific (either by property name, or name and a specific value). The field determines what kind of events are returned (events, todo lists, journal entries, or free/busy time).

Fields

Constructors

public init()

CalTimezone Type

Specifies a time zone on a calendar collection.

Remarks

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

Fields

Constructors

public init()

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

Fields

Constructors

public init()

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

Fields

Constructors

public init()

public init(field: , value: )

HTTPCookie Type

An HTTP cookie can be either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.

Cookies that are to be sent to the server must have the and fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.

Fields

Constructors

public init()

public init(name: , value: )

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

Fields

Constructors

public init()

public init(server: , port: )

public init(server: , port: , user: , password: )

Config Settings (CalDAV Module)

CalDAV Config Settings

WebDAV Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings