# CalDAV Component

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

## Syntax

```text
ipworks.CalDAV
```

## Remarks

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

The [GetCalendarReport](#getcalendarreport-method-caldav-component) method will list the event resources contained in the calendar, and the ReportFilter can be used to limit the results returned. The [EventDetails](#eventdetails-event-caldav-component) 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](#getfreebusyreport-method-caldav-component). The [FreeBusy](#freebusy-event-caldav-component) event will fire for each entry received, and the data fired in the event will also be stored in the FreeBusy property.

Single events can be added to a calendar (or updated) using the [CreateEvent](#createevent-method-caldav-component) method, and can be retrieved via the [GetEvent](#getevent-method-caldav-component) method. Events may be copied or moved with the [CopyEvent](#copyevent-method-caldav-component) and [MoveEvent](#moveevent-method-caldav-component).

The following properties are used when creating a request with [CreateEvent](#createevent-method-caldav-component) or [ExportICS](#exportics-method-caldav-component), and will be filled after calling [GetEvent](#getevent-method-caldav-component) or [ImportICS](#importics-method-caldav-component). These will also be available from inside the [EventDetails](#eventdetails-event-caldav-component) event, which is fired for each event received from the CalDAV server in response to a [GetCalendarReport](#getcalendarreport-method-caldav-component).

- Alarms
- [Attendees](#attendees-property-caldav-component)
- [Categories](#categories-property-caldav-component)
- [Classification](#classification-property-caldav-component)
- [Completed](#completed-property-caldav-component)
- [Created](#Created)
- CustomProperties
- [Depth](#Depth)
- [Description](#description-property-caldav-component)
- [Duration](#duration-property-caldav-component)
- [EndDate](#enddate-property-caldav-component)
- [EventType](#eventtype-property-caldav-component)
- [LastModified](#lastmodified-property-caldav-component)
- [Location](#location-property-caldav-component)
- [Organizer](#organizer-property-caldav-component)
- [Priority](#priority-property-caldav-component)
- Recurrence
- [Sequence](#sequence-property-caldav-component)
- [StartDate](#startdate-property-caldav-component)
- [Status](#status-property-caldav-component)
- [Summary](#summary-property-caldav-component)
- [Timestamp](#timestamp-property-caldav-component)
- Timezone
- [Transparency](#transparency-property-caldav-component)
- [UID](#uid-property-caldav-component)
- [URL](#url-property-caldav-component)

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

- [CopyEvent](#copyevent-method-caldav-component)
- [DeleteEvent](#deleteevent-method-caldav-component)
- [MoveEvent](#moveevent-method-caldav-component)
- [GetEvent](#getevent-method-caldav-component)
- [CreateEvent](#createevent-method-caldav-component)

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

- [CreateCalendar](#createcalendar-method-caldav-component)
- [GetCalendarOptions](#getcalendaroptions-method-caldav-component)
- [GetCalendarReport](#getcalendarreport-method-caldav-component)
- [GetFreeBusyReport](#getfreebusyreport-method-caldav-component)

 The [LockCalendar](#lockcalendar-method-caldav-component) and [UnLockCalendar](#unlockcalendar-method-caldav-component) methods may operate on individual events or on the whole calendar.

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

```csharp
  CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/");
```

 Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the [CreateEvent](#createevent-method-caldav-component) method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the [UID](#uid-property-caldav-component) property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with [GetEvent](#getevent-method-caldav-component). For example:

```csharp
  CalDAV.UID = "1234567890";
  CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");
```

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the [CreateCalendar](#createcalendar-method-caldav-component) 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:

```csharp
  CalDAV.User = "username";
  CalDAV.Password = "password";

  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar");

  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");

  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
```

## Property List

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

|  |  |
| --- | --- |
| [AlarmCount](#alarmcount-property-caldav-component) | The number of records in the Alarm arrays. |
| [AlarmAction](#alarmaction-property-caldav-component) | This property determines what the CalDAV server will do when the alarm Trigger is reached. |
| [AlarmAttachment](#alarmattachment-property-caldav-component) | This property contains a sound file attached to the alarm. |
| [AlarmAttachmentType](#alarmattachmenttype-property-caldav-component) | This property contains the MIME-Type of the attachment. |
| [AlarmDuration](#alarmduration-property-caldav-component) | This property contains the interval between repeating alarms. |
| [AlarmMessage](#alarmmessage-property-caldav-component) | This property contains a message used to alert the user when this alarm is triggered. |
| [AlarmRecipient](#alarmrecipient-property-caldav-component) | This property contains the email address of the person to be alerted when this alarm is triggered. |
| [AlarmRepeat](#alarmrepeat-property-caldav-component) | This property contains the number of times the alarm is to be repeated after the initial trigger. |
| [AlarmSubject](#alarmsubject-property-caldav-component) | This property contains the subject of the message used to alert the user when this alarm is triggered. |
| [AlarmTrigger](#alarmtrigger-property-caldav-component) | This property contains the time when the alarm is triggered. |
| [Attendees](#attendees-property-caldav-component) | Defines one or more participants that have been invited to the event. |
| [Authorization](#authorization-property-caldav-component) | This property includes the Authorization string to be sent to the server. |
| [AuthScheme](#authscheme-property-caldav-component) | This property specifies the authentication scheme to use when server authentication is required. |
| [CalendarCount](#calendarcount-property-caldav-component) | The number of records in the Calendar arrays. |
| [CalendarColor](#calendarcolor-property-caldav-component) | This property specifies the calendar's color. |
| [CalendarCTag](#calendarctag-property-caldav-component) | This property holds the current ctag of the calendar. |
| [CalendarDescription](#calendardescription-property-caldav-component) | This property holds the description of the calendar. |
| [CalendarDisplayName](#calendardisplayname-property-caldav-component) | This property holds the display name of the calendar. |
| [CalendarPropertyCount](#calendarpropertycount-property-caldav-component) | This property holds the total number of properties of the calendar. |
| [CalendarPropertyIndex](#calendarpropertyindex-property-caldav-component) | This property specifies the currently selected property. |
| [CalendarPropertyName](#calendarpropertyname-property-caldav-component) | This property holds the name of the currently selected property. |
| [CalendarPropertyValue](#calendarpropertyvalue-property-caldav-component) | This property holds the value of the currently selected property. |
| [CalendarURL](#calendarurl-property-caldav-component) | This property provides the URL of the calendar. |
| [Categories](#categories-property-caldav-component) | Used to specify categories or subtypes of the calendar event. |
| [Classification](#classification-property-caldav-component) | Defines the access classification for a calendar class. |
| [Completed](#completed-property-caldav-component) | Date and time that a to-do was actually completed. |
| [Connected](#connected-property-caldav-component) | Whether the class is connected. |
| [CookieCount](#cookiecount-property-caldav-component) | The number of records in the Cookie arrays. |
| [CookieDomain](#cookiedomain-property-caldav-component) | The domain of a received cookie. |
| [CookieExpiration](#cookieexpiration-property-caldav-component) | An expiration time for the cookie (if provided by the server). |
| [CookieName](#cookiename-property-caldav-component) | The name of the cookie. |
| [CookiePath](#cookiepath-property-caldav-component) | A path name to limit the cookie to (if provided by the server). |
| [CookieSecure](#cookiesecure-property-caldav-component) | The security flag of the received cookie. |
| [CookieValue](#cookievalue-property-caldav-component) | The value of the cookie. |
| [CustomPropertyCount](#custompropertycount-property-caldav-component) | The number of records in the CustomProperty arrays. |
| [CustomPropertyAttribute](#custompropertyattribute-property-caldav-component) | This property contains an optional attribute of the custom property. |
| [CustomPropertyName](#custompropertyname-property-caldav-component) | This property contains the textual name of the custom property. |
| [CustomPropertyValue](#custompropertyvalue-property-caldav-component) | This property contains the value of the custom property. |
| [Description](#description-property-caldav-component) | Provides a complete description of the calendar event. |
| [DueDate](#duedate-property-caldav-component) | Specifies the due date for a calendar event. |
| [Duration](#duration-property-caldav-component) | Duration of the calendar event. |
| [EndDate](#enddate-property-caldav-component) | Specifies the date and time that a calendar event ends. |
| [ETag](#etag-property-caldav-component) | Identifier returned by the CalDAV server which is used to synchronize edits. |
| [EventType](#eventtype-property-caldav-component) | Indicates the type of calendar object resource. |
| [FirewallAutoDetect](#firewallautodetect-property-caldav-component) | Whether to automatically detect and use firewall system settings, if available. |
| [FirewallType](#firewalltype-property-caldav-component) | The type of firewall to connect through. |
| [FirewallHost](#firewallhost-property-caldav-component) | The name or IP address of the firewall (optional). |
| [FirewallPassword](#firewallpassword-property-caldav-component) | A password if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#firewallport-property-caldav-component) | The Transmission Control Protocol (TCP) port for the firewall Host . |
| [FirewallUser](#firewalluser-property-caldav-component) | A username if authentication is to be used when connecting through a firewall. |
| [FollowRedirects](#followredirects-property-caldav-component) | Determines what happens when the server issues a redirect. |
| [FreeBusyCount](#freebusycount-property-caldav-component) | The number of records in the FreeBusy arrays. |
| [FreeBusyRange](#freebusyrange-property-caldav-component) | Contains the date/time range when the calendar owner is busy. |
| [FreeBusyType](#freebusytype-property-caldav-component) | Indicates the busy status of the corresponding BusyRange . |
| [Idle](#idle-property-caldav-component) | The current status of the class. |
| [LastModified](#lastmodified-property-caldav-component) | The date and time that the information associated with the calendar event was last revised in the calendar store. |
| [LocalHost](#localhost-property-caldav-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [Location](#location-property-caldav-component) | Defines the intended venue for the activity defined by a calendar class. |
| [LockType](#locktype-property-caldav-component) | The type of the current resource lock. |
| [LockOwner](#lockowner-property-caldav-component) | The principle that owns the current resource lock. |
| [LockScope](#lockscope-property-caldav-component) | The scope of the current resource lock. |
| [LockTimeout](#locktimeout-property-caldav-component) | The time to live for the current resource lock. |
| [LockToken](#locktoken-property-caldav-component) | The lock string to be used when submitting operations on a locked resource. |
| [Organizer](#organizer-property-caldav-component) | Defines the organizer of a calendar event. |
| [OtherHeaders](#otherheaders-property-caldav-component) | Other headers as determined by the user (optional). |
| [ParsedHeaderCount](#parsedheadercount-property-caldav-component) | The number of records in the ParsedHeader arrays. |
| [ParsedHeaderField](#parsedheaderfield-property-caldav-component) | This property contains the name of the HTTP header (this is the same case as it is delivered). |
| [ParsedHeaderValue](#parsedheadervalue-property-caldav-component) | This property contains the header contents. |
| [Password](#password-property-caldav-component) | This property includes a password if authentication is to be used. |
| [Priority](#priority-property-caldav-component) | Defines the relative priority for a calendar event. |
| [ProxyAuthScheme](#proxyauthscheme-property-caldav-component) | The type of authorization to perform when connecting to the proxy. |
| [ProxyAutoDetect](#proxyautodetect-property-caldav-component) | Whether to automatically detect and use proxy system settings, if available. |
| [ProxyPassword](#proxypassword-property-caldav-component) | A password if authentication is to be used for the proxy. |
| [ProxyPort](#proxyport-property-caldav-component) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
| [ProxyServer](#proxyserver-property-caldav-component) | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| [ProxySSL](#proxyssl-property-caldav-component) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
| [ProxyUser](#proxyuser-property-caldav-component) | A username if authentication is to be used for the proxy. |
| [RecurrenceDates](#recurrencedates-property-caldav-component) | Individual dates on which the event will recur. |
| [RecurrenceExceptionDates](#recurrenceexceptiondates-property-caldav-component) | Defines the list of DATE-TIME exceptions to the recurrence set. |
| [RecurrenceExceptionRule](#recurrenceexceptionrule-property-caldav-component) | Defines a rule or repeating pattern for an exception to the recurrence set. |
| [RecurrenceId](#recurrenceid-property-caldav-component) | Identifies a recurring event. |
| [RecurrenceRule](#recurrencerule-property-caldav-component) | This property defines the recurrence rule for the event. |
| [RelatedTo](#relatedto-property-caldav-component) | Represents a relationship or reference between this calendar event and another. |
| [ReportFilterAlarmEnd](#reportfilteralarmend-property-caldav-component) | Limits the events returned in the report to only those with an alarm set in the range specified by AlarmStart and AlarmEnd . |
| [ReportFilterAlarmStart](#reportfilteralarmstart-property-caldav-component) | Limits the events returned in the report to only those with an alarm set in the range specified by AlarmStart and AlarmEnd . |
| [ReportFilterCustomFilter](#reportfiltercustomfilter-property-caldav-component) | Allows the user to specify his own filter XML. |
| [ReportFilterEndDate](#reportfilterenddate-property-caldav-component) | Limits the events returned in the report to only those which occur in the time range specified by StartDate and EndDate . |
| [ReportFilterEventType](#reportfiltereventtype-property-caldav-component) | Indicates the type of calendar object resources to return in a Report. |
| [ReportFilterProperty](#reportfilterproperty-property-caldav-component) | Limits the events returned in a Report to only those which contain a matching property name and value. |
| [ReportFilterRecurEnd](#reportfilterrecurend-property-caldav-component) | Limits the recurring events returned in the report. |
| [ReportFilterRecurStart](#reportfilterrecurstart-property-caldav-component) | Limits the recurring events returned in the report. |
| [ReportFilterReturnCalendarData](#reportfilterreturncalendardata-property-caldav-component) | Controls whether the contents of each calendar event is returned in the report. |
| [ReportFilterStartDate](#reportfilterstartdate-property-caldav-component) | Limits the events returned in the report to only those which occur in the time range specified by StartDate and EndDate . |
| [ReportFilterUID](#reportfilteruid-property-caldav-component) | Limits the recurring events returned in the report to only those with the specified UID. |
| [Sequence](#sequence-property-caldav-component) | Defines the revision sequence number of the event within a sequence of revisions. |
| [SSLAcceptServerCertEffectiveDate](#sslacceptservercerteffectivedate-property-caldav-component) | The date on which this certificate becomes valid. |
| [SSLAcceptServerCertExpirationDate](#sslacceptservercertexpirationdate-property-caldav-component) | The date on which the certificate expires. |
| [SSLAcceptServerCertExtendedKeyUsage](#sslacceptservercertextendedkeyusage-property-caldav-component) | A comma-delimited list of extended key usage identifiers. |
| [SSLAcceptServerCertFingerprint](#sslacceptservercertfingerprint-property-caldav-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SSLAcceptServerCertFingerprintSHA1](#sslacceptservercertfingerprintsha1-property-caldav-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SSLAcceptServerCertFingerprintSHA256](#sslacceptservercertfingerprintsha256-property-caldav-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SSLAcceptServerCertIssuer](#sslacceptservercertissuer-property-caldav-component) | The issuer of the certificate. |
| [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-caldav-component) | The private key of the certificate (if available). |
| [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-caldav-component) | Whether a PrivateKey is available for the selected certificate. |
| [SSLAcceptServerCertPrivateKeyContainer](#sslacceptservercertprivatekeycontainer-property-caldav-component) | The name of the PrivateKey container for the certificate (if available). |
| [SSLAcceptServerCertPublicKey](#sslacceptservercertpublickey-property-caldav-component) | The public key of the certificate. |
| [SSLAcceptServerCertPublicKeyAlgorithm](#sslacceptservercertpublickeyalgorithm-property-caldav-component) | The textual description of the certificate's public key algorithm. |
| [SSLAcceptServerCertPublicKeyLength](#sslacceptservercertpublickeylength-property-caldav-component) | The length of the certificate's public key (in bits). |
| [SSLAcceptServerCertSerialNumber](#sslacceptservercertserialnumber-property-caldav-component) | The serial number of the certificate encoded as a string. |
| [SSLAcceptServerCertSignatureAlgorithm](#sslacceptservercertsignaturealgorithm-property-caldav-component) | The text description of the certificate's signature algorithm. |
| [SSLAcceptServerCertStore](#sslacceptservercertstore-property-caldav-component) | The name of the certificate store for the client certificate. |
| [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-caldav-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-caldav-component) | The type of certificate store for this certificate. |
| [SSLAcceptServerCertSubjectAltNames](#sslacceptservercertsubjectaltnames-property-caldav-component) | Comma-separated lists of alternative subject names for the certificate. |
| [SSLAcceptServerCertThumbprintMD5](#sslacceptservercertthumbprintmd5-property-caldav-component) | The MD5 hash of the certificate. |
| [SSLAcceptServerCertThumbprintSHA1](#sslacceptservercertthumbprintsha1-property-caldav-component) | The SHA-1 hash of the certificate. |
| [SSLAcceptServerCertThumbprintSHA256](#sslacceptservercertthumbprintsha256-property-caldav-component) | The SHA-256 hash of the certificate. |
| [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-caldav-component) | The text description of UsageFlags . |
| [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-caldav-component) | The flags that show intended use for the certificate. |
| [SSLAcceptServerCertVersion](#sslacceptservercertversion-property-caldav-component) | The certificate's version number. |
| [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-caldav-component) | The subject of the certificate used for client authentication. |
| [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-caldav-component) | The certificate (PEM/Base64 encoded). |
| [SSLCertEffectiveDate](#sslcerteffectivedate-property-caldav-component) | The date on which this certificate becomes valid. |
| [SSLCertExpirationDate](#sslcertexpirationdate-property-caldav-component) | The date on which the certificate expires. |
| [SSLCertExtendedKeyUsage](#sslcertextendedkeyusage-property-caldav-component) | A comma-delimited list of extended key usage identifiers. |
| [SSLCertFingerprint](#sslcertfingerprint-property-caldav-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SSLCertFingerprintSHA1](#sslcertfingerprintsha1-property-caldav-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SSLCertFingerprintSHA256](#sslcertfingerprintsha256-property-caldav-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SSLCertIssuer](#sslcertissuer-property-caldav-component) | The issuer of the certificate. |
| [SSLCertPrivateKey](#sslcertprivatekey-property-caldav-component) | The private key of the certificate (if available). |
| [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-caldav-component) | Whether a PrivateKey is available for the selected certificate. |
| [SSLCertPrivateKeyContainer](#sslcertprivatekeycontainer-property-caldav-component) | The name of the PrivateKey container for the certificate (if available). |
| [SSLCertPublicKey](#sslcertpublickey-property-caldav-component) | The public key of the certificate. |
| [SSLCertPublicKeyAlgorithm](#sslcertpublickeyalgorithm-property-caldav-component) | The textual description of the certificate's public key algorithm. |
| [SSLCertPublicKeyLength](#sslcertpublickeylength-property-caldav-component) | The length of the certificate's public key (in bits). |
| [SSLCertSerialNumber](#sslcertserialnumber-property-caldav-component) | The serial number of the certificate encoded as a string. |
| [SSLCertSignatureAlgorithm](#sslcertsignaturealgorithm-property-caldav-component) | The text description of the certificate's signature algorithm. |
| [SSLCertStore](#sslcertstore-property-caldav-component) | The name of the certificate store for the client certificate. |
| [SSLCertStorePassword](#sslcertstorepassword-property-caldav-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SSLCertStoreType](#sslcertstoretype-property-caldav-component) | The type of certificate store for this certificate. |
| [SSLCertSubjectAltNames](#sslcertsubjectaltnames-property-caldav-component) | Comma-separated lists of alternative subject names for the certificate. |
| [SSLCertThumbprintMD5](#sslcertthumbprintmd5-property-caldav-component) | The MD5 hash of the certificate. |
| [SSLCertThumbprintSHA1](#sslcertthumbprintsha1-property-caldav-component) | The SHA-1 hash of the certificate. |
| [SSLCertThumbprintSHA256](#sslcertthumbprintsha256-property-caldav-component) | The SHA-256 hash of the certificate. |
| [SSLCertUsage](#sslcertusage-property-caldav-component) | The text description of UsageFlags . |
| [SSLCertUsageFlags](#sslcertusageflags-property-caldav-component) | The flags that show intended use for the certificate. |
| [SSLCertVersion](#sslcertversion-property-caldav-component) | The certificate's version number. |
| [SSLCertSubject](#sslcertsubject-property-caldav-component) | The subject of the certificate used for client authentication. |
| [SSLCertEncoded](#sslcertencoded-property-caldav-component) | The certificate (PEM/Base64 encoded). |
| [SSLProvider](#sslprovider-property-caldav-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [SSLServerCertEffectiveDate](#sslservercerteffectivedate-property-caldav-component) | The date on which this certificate becomes valid. |
| [SSLServerCertExpirationDate](#sslservercertexpirationdate-property-caldav-component) | The date on which the certificate expires. |
| [SSLServerCertExtendedKeyUsage](#sslservercertextendedkeyusage-property-caldav-component) | A comma-delimited list of extended key usage identifiers. |
| [SSLServerCertFingerprint](#sslservercertfingerprint-property-caldav-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SSLServerCertFingerprintSHA1](#sslservercertfingerprintsha1-property-caldav-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SSLServerCertFingerprintSHA256](#sslservercertfingerprintsha256-property-caldav-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SSLServerCertIssuer](#sslservercertissuer-property-caldav-component) | The issuer of the certificate. |
| [SSLServerCertPrivateKey](#sslservercertprivatekey-property-caldav-component) | The private key of the certificate (if available). |
| [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-caldav-component) | Whether a PrivateKey is available for the selected certificate. |
| [SSLServerCertPrivateKeyContainer](#sslservercertprivatekeycontainer-property-caldav-component) | The name of the PrivateKey container for the certificate (if available). |
| [SSLServerCertPublicKey](#sslservercertpublickey-property-caldav-component) | The public key of the certificate. |
| [SSLServerCertPublicKeyAlgorithm](#sslservercertpublickeyalgorithm-property-caldav-component) | The textual description of the certificate's public key algorithm. |
| [SSLServerCertPublicKeyLength](#sslservercertpublickeylength-property-caldav-component) | The length of the certificate's public key (in bits). |
| [SSLServerCertSerialNumber](#sslservercertserialnumber-property-caldav-component) | The serial number of the certificate encoded as a string. |
| [SSLServerCertSignatureAlgorithm](#sslservercertsignaturealgorithm-property-caldav-component) | The text description of the certificate's signature algorithm. |
| [SSLServerCertStore](#sslservercertstore-property-caldav-component) | The name of the certificate store for the client certificate. |
| [SSLServerCertStorePassword](#sslservercertstorepassword-property-caldav-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SSLServerCertStoreType](#sslservercertstoretype-property-caldav-component) | The type of certificate store for this certificate. |
| [SSLServerCertSubjectAltNames](#sslservercertsubjectaltnames-property-caldav-component) | Comma-separated lists of alternative subject names for the certificate. |
| [SSLServerCertThumbprintMD5](#sslservercertthumbprintmd5-property-caldav-component) | The MD5 hash of the certificate. |
| [SSLServerCertThumbprintSHA1](#sslservercertthumbprintsha1-property-caldav-component) | The SHA-1 hash of the certificate. |
| [SSLServerCertThumbprintSHA256](#sslservercertthumbprintsha256-property-caldav-component) | The SHA-256 hash of the certificate. |
| [SSLServerCertUsage](#sslservercertusage-property-caldav-component) | The text description of UsageFlags . |
| [SSLServerCertUsageFlags](#sslservercertusageflags-property-caldav-component) | The flags that show intended use for the certificate. |
| [SSLServerCertVersion](#sslservercertversion-property-caldav-component) | The certificate's version number. |
| [SSLServerCertSubject](#sslservercertsubject-property-caldav-component) | The subject of the certificate used for client authentication. |
| [SSLServerCertEncoded](#sslservercertencoded-property-caldav-component) | The certificate (PEM/Base64 encoded). |
| [StartDate](#startdate-property-caldav-component) | Specifies the date and time that an event begins. |
| [Status](#status-property-caldav-component) | Defines the overall status or confirmation for the calendar event. |
| [Summary](#summary-property-caldav-component) | Defines a short summary or subject for the calendar event. |
| [Timeout](#timeout-property-caldav-component) | The timeout for the class. |
| [Timestamp](#timestamp-property-caldav-component) | Specifies the date and time that the instance of the event was created. |
| [TimezoneDSTName](#timezonedstname-property-caldav-component) | The customary name for the daylight-savings time zone. |
| [TimezoneDSTOffsetFrom](#timezonedstoffsetfrom-property-caldav-component) | The UTC offset that is in use when the onset of this time zone observance begins. |
| [TimezoneDSTOffsetTo](#timezonedstoffsetto-property-caldav-component) | The UTC offset for daylight savings time, when this observance is in use. |
| [TimezoneDSTRule](#timezonedstrule-property-caldav-component) | This property defines the recurrence rule for the onset of this daylight savings time observance. |
| [TimezoneDSTStart](#timezonedststart-property-caldav-component) | The effective onset date and local time for the daylight-time time zone definition. |
| [TimezoneLastModified](#timezonelastmodified-property-caldav-component) | This optional property is a UTC value that specifies the date and time that this time zone definition was last updated. |
| [TimezoneStdName](#timezonestdname-property-caldav-component) | The customary name for the standard time zone. |
| [TimezoneStdOffsetFrom](#timezonestdoffsetfrom-property-caldav-component) | The UTC offset that is in use when the onset of this time zone observance begins. |
| [TimezoneStdOffsetTo](#timezonestdoffsetto-property-caldav-component) | The UTC offset for standard time, when this observance is in use. |
| [TimezoneStdRule](#timezonestdrule-property-caldav-component) | This property defines the recurrence rule for the onset of this standard time observance. |
| [TimezoneStdStart](#timezonestdstart-property-caldav-component) | The effective onset date and local time for the standard-time time zone definition. |
| [TimezoneId](#timezoneid-property-caldav-component) | This property specifies a text value that uniquely identifies this CalTimezone calendar class. |
| [TimezoneURL](#timezoneurl-property-caldav-component) | Optionally points to a published time zone definition. |
| [Transparency](#transparency-property-caldav-component) | Defines whether or not an event is transparent to busy time searches. |
| [UID](#uid-property-caldav-component) | A persistent, globally unique identifier for the calendar event. |
| [URL](#url-property-caldav-component) | Location of the event resource on the CalDAV server. |
| [User](#user-property-caldav-component) | This property includes a user name if authentication is to be used. |

## Method List

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

|  |  |
| --- | --- |
| [AddCookie](#addcookie-method-caldav-component) | Adds a cookie and the corresponding value to the outgoing request headers. |
| [AddCustomProperty](#addcustomproperty-method-caldav-component) | Adds a form variable and the corresponding value. |
| [Config](#config-method-caldav-component) | Sets or retrieves a configuration setting. |
| [CopyEvent](#copyevent-method-caldav-component) | Copy events to a new location. |
| [CreateCalendar](#createcalendar-method-caldav-component) | Creates a new calendar collection resource. |
| [CreateEvent](#createevent-method-caldav-component) | Adds a calendar resource at the specified ResourceURI using the CalDAV PUT method. |
| [DeleteCalendar](#deletecalendar-method-caldav-component) | Deletes a calendar collection resource. |
| [DeleteEvent](#deleteevent-method-caldav-component) | Delete a resource or collection. |
| [DoEvents](#doevents-method-caldav-component) | This method processes events from the internal message queue. |
| [ExportICS](#exportics-method-caldav-component) | Generates an event from the properties in the iCal (.ICS) format. |
| [GetCalendarOptions](#getcalendaroptions-method-caldav-component) | Retrieves options for the ResourceURI to determines whether it supports calendar access. |
| [GetCalendarReport](#getcalendarreport-method-caldav-component) | Generates a report on the indicated calendar collection resource. |
| [GetEvent](#getevent-method-caldav-component) | Retrieves a single event from the CalDAV server. |
| [GetFreeBusyReport](#getfreebusyreport-method-caldav-component) | Generates a report as to when the calendar owner is free and/or busy. |
| [ImportICS](#importics-method-caldav-component) | Imports calendar data (contained in an ICS file) into the class's property list. |
| [Interrupt](#interrupt-method-caldav-component) | This method interrupts the current method. |
| [ListCalendars](#listcalendars-method-caldav-component) | Lists all calendars that the current user can access. |
| [LockCalendar](#lockcalendar-method-caldav-component) | Obtain a lock for a specified calendar resource. |
| [MoveEvent](#moveevent-method-caldav-component) | Moves one calendar resource to a new location. |
| [Reset](#reset-method-caldav-component) | Reset the class. |
| [SendCustomRequest](#sendcustomrequest-method-caldav-component) | Sends a request to the CalDAV server to do CRUD operations. |
| [UnLockCalendar](#unlockcalendar-method-caldav-component) | Unlocks a calendar resource. |
| [UpdateCalendar](#updatecalendar-method-caldav-component) | Updates a calendar collection resource. |
| [UpdateEvent](#updateevent-method-caldav-component) | Updates a calendar resource at the specified ResourceURI using the CalDAV PUT method. |

## Event List

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

|  |  |
| --- | --- |
| [Connected](#connected-event-caldav-component) | Fired immediately after a connection completes (or fails). |
| [ConnectionStatus](#connectionstatus-event-caldav-component) | Fired to indicate changes in the connection state. |
| [Disconnected](#disconnected-event-caldav-component) | Fired when a connection is closed. |
| [EndTransfer](#endtransfer-event-caldav-component) | This event is fired when a document finishes transferring. |
| [Error](#error-event-caldav-component) | Fired when information is available about errors during data delivery. |
| [EventDetails](#eventdetails-event-caldav-component) | Fires for each calendar event received. |
| [FreeBusy](#freebusy-event-caldav-component) | Fires for each Free/Busy element received in the response. |
| [Header](#header-event-caldav-component) | Fired every time a header line comes in. |
| [Log](#log-event-caldav-component) | Fired once for each log message. |
| [Redirect](#redirect-event-caldav-component) | Fired when a redirection is received from the server. |
| [SetCookie](#setcookie-event-caldav-component) | Fired for every cookie set by the server. |
| [SSLServerAuthentication](#sslserverauthentication-event-caldav-component) | Fired after the server presents its certificate to the client. |
| [SSLStatus](#sslstatus-event-caldav-component) | Fired when secure connection progress messages are available. |
| [StartTransfer](#starttransfer-event-caldav-component) | This event is fired when a document starts transferring (after the headers). |
| [Status](#status-event-caldav-component) | Fired when the HTTP status line is received from the server. |
| [Transfer](#transfer-event-caldav-component) | Fired while a document transfers (delivers document). |

## Config Settings

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

|  |  |
| --- | --- |
| [AttendeeFormat](#AttendeeFormat) | Specifies the format of the Attendees property. |
| [AuthScheme](#AuthScheme) | The authentication scheme to use for server authorization. |
| [BuildEvent](#BuildEvent) | Builds the current event for a multi-event calendar entry. |
| [Created](#Created) | Date and time calendar event was created. |
| [Depth](#Depth) | The depth associated with the current operation. |
| [EndCalendar](#EndCalendar) | Signifies the end of a multi-event calendar entry. |
| [ExpandRecurringEvents](#ExpandRecurringEvents) | Instructs the class to return all instances of a recurring event within a timeframe. |
| [ProductId](#ProductId) | Specifies the identifier for the product that created the iCalendar object. |
| [RecurrenceExceptionDatesAttrs](#RecurrenceExceptionDatesAttrs) | Specifies the attributes for the exception dates of a recurring event. |
| [StartCalendar](#StartCalendar) | Signifies the beginning of a multi-event calendar entry. |
| [EncodeURL](#EncodeURL) | If set to true the URL will be encoded by the class. |
| [IsDir\[i\]](#IsDir[i]) | Whether or not the resource at the specified index is a directory. |
| [TransferredData](#TransferredData) | Contains the contents of the last response from the server. |
| [TransferredDataLimit](#TransferredDataLimit) | The maximum amount of data to be transferred. |
| [XChildCount](#XChildCount) | The number of child elements of the current element. |
| [XChildName\[i\]](#XChildName[i]) | The name of the child element. |
| [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. |
| [XElement](#XElement) | The name of the current element. |
| [XParent](#XParent) | The parent of the current element. |
| [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. |
| [XSubTree](#XSubTree) | A snapshot of the current element in the document. |
| [XText](#XText) | The text of the current element. |
| [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. |
| [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. |
| [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| [Append](#Append) | Whether to append data to LocalFile. |
| [Authorization](#Authorization) | The Authorization string to be sent to the server. |
| [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. |
| [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. |
| [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. |
| [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. |
| [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. |
| [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. |
| [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. |
| [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. |
| [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. |
| [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. |
| [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. |
| [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). |
| [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. |
| [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. |
| [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. |
| [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). |
| [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). |
| [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. |
| [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. |
| [StatusCode](#StatusCode) | The status code of the last response from the server. |
| [StatusLine](#StatusLine) | The first line of the last response from the server. |
| [TransferredData](#TransferredData) | The contents of the last response from the server. |
| [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. |
| [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. |
| [TransferredRequest](#TransferredRequest) | The full request as sent by the client. |
| [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. |
| [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. |
| [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. |
| [UserAgent](#UserAgent) | Information about the user agent (browser). |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). |
| [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. |
| [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. |
| [FirewallType](#FirewallType) | Determines the type of firewall to connect through. |
| [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| [Linger](#Linger) | When set to True, connections are terminated gracefully. |
| [LingerTime](#LingerTime) | Time in seconds to have the connection linger. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the class binds. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. |
| [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. |
| [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. |
| [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. |
| [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. |
| [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. |
| [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. |
| [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# AlarmCount Property ([CalDAV](#caldav-component) Component)

The number of records in the Alarm arrays.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) AlarmCount() (int32, error)func (obj *CalDAV) SetAlarmCount(value int32) error
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [AlarmAction](#alarmaction-property-caldav-component)
- [AlarmAttachment](#alarmattachment-property-caldav-component)
- [AlarmAttachmentType](#alarmattachmenttype-property-caldav-component)
- [AlarmDuration](#alarmduration-property-caldav-component)
- [AlarmMessage](#alarmmessage-property-caldav-component)
- [AlarmRecipient](#alarmrecipient-property-caldav-component)
- [AlarmRepeat](#alarmrepeat-property-caldav-component)
- [AlarmSubject](#alarmsubject-property-caldav-component)
- [AlarmTrigger](#alarmtrigger-property-caldav-component)

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

## Data Type

**int32**

# AlarmAction Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) AlarmAction(AlarmIndex int32) (int32, error)func (obj *CalDAV) SetAlarmAction(AlarmIndex int32, value int32) error
```

## Possible Values

```text
0   // NoAlarm1   // Audio2   // Display3   // Email
```

## Default Value

0

## Remarks

This property determines what the CalDAV server will do when the alarm [AlarmTrigger](#alarmtrigger-property-caldav-component) is reached. The following table explains the possible alarm actions:

|  |  |
| --- | --- |
| aAudio (0) | Specifies an alarm that causes a sound to be played to alert the user. You may attach a custom sound file using the [AlarmAttachment](#alarmattachment-property-caldav-component) property. |
| aDisplay (1) | Specifies an alarm that causes a visual alert to be displayed to the user. If [AlarmAction](#alarmaction-property-caldav-component) is set to this value, you must also set the [AlarmMessage](#alarmmessage-property-caldav-component) property with the message to be displayed. |
| aEmail (2) | Instructs the CalDAV sever to email a specified [AlarmRecipient](#alarmrecipient-property-caldav-component). In this case, the [AlarmMessage](#alarmmessage-property-caldav-component) property will contain the message body of the email and the [AlarmSubject](#alarmsubject-property-caldav-component) property should contain the subject line. |

The *AlarmIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AlarmCount](#alarmcount-property-caldav-component) property.

## Data Type

**int32**

# AlarmAttachment Property ([CalDAV](#caldav-component) Component)

This property contains a sound file attached to the alarm.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) AlarmAttachment(AlarmIndex int32) (string, error)func (obj *CalDAV) SetAlarmAttachment(AlarmIndex int32, value string) error
```

## Default Value

""

## Remarks

This property contains a sound file attached to the alarm. If the [AlarmAction](#alarmaction-property-caldav-component) is set to *aAudio*, this property may optionally contain a base-64 encoded binary sound file to be played. The [AlarmAttachmentType](#alarmattachmenttype-property-caldav-component) property indicates the data type of the attached file.

The *AlarmIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AlarmCount](#alarmcount-property-caldav-component) property.

## Data Type

**string**

# AlarmAttachmentType Property ([CalDAV](#caldav-component) Component)

This property contains the MIME-Type of the attachment.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) AlarmAttachmentType(AlarmIndex int32) (string, error)func (obj *CalDAV) SetAlarmAttachmentType(AlarmIndex int32, value string) error
```

## Default Value

""

## Remarks

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

|  |  |  |
| --- | --- | --- |
| AttachmentType | File Extension | Description |
| audio/basic | au, snd | basic audio, 8-bit u-law PCM. |
| audio/mid | mid, rmi | MIDI music data |
| audio/mpeg | mp2, mp3 | MPEG-1 Audio Layer II and III. |
| audio/x-aiff | aiff, aif, aifc | Macintosh audio format |
| audio/x-mp4a-latm | m4a | MPEG-4 Audio |
| audio/x-pn-realaudio | ra, ram | Realaudio |
| audio/x-wav | wav | Microsoft waveform audio |
| audio/x-ms-wma | wma | Windows Media Audio (Microsoft) |

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

The *AlarmIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AlarmCount](#alarmcount-property-caldav-component) property.

## Data Type

**string**

# AlarmDuration Property ([CalDAV](#caldav-component) Component)

This property contains the interval between repeating alarms.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) AlarmDuration(AlarmIndex int32) (string, error)func (obj *CalDAV) SetAlarmDuration(AlarmIndex int32, value string) error
```

## Default Value

""

## Remarks

This property contains the interval between repeating alarms. This property is only used when an alarm is set to [AlarmRepeat](#alarmrepeat-property-caldav-component) multiple times. It is specified in the form of a Duration data type. Durations are represented by the format **P**<date>**T**<time>. The **date** component may contain a number of days or weeks (but not months or years), and the **time** component may consist of hours, minutes, and seconds. These are represented by an integer value followed by a letter representing the units, as specified by the table below:

|  |  |
| --- | --- |
| P | is the duration designator (historically called "period") placed at the start of the duration representation. |
| W | is the week designator that follows the value for the number of weeks. |
| D | is the day designator that follows the value for the number of days. |
| T | is the time designator that precedes the time components of the representation. |
| H | is the hour designator that follows the value for the number of hours. |
| M | is the minute designator that follows the value for the number of minutes. |
| S | is the second designator that follows the value for the number of seconds. |

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

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

The following is an example of an alarm that repeats 4 additional times after the initial [AlarmTrigger](#alarmtrigger-property-caldav-component), with a 5-minute delay between each alarm:

```text
  CalDav.Trigger = "-PT10M";
  CalDAV.Alarm.Repeat = 4;
  CalDAV.Duration = "PT5M"
  CalDAV.Action = aDisplay;
```

If [AlarmDuration](#alarmduration-property-caldav-component) is specified, [AlarmRepeat](#alarmrepeat-property-caldav-component) MUST also be specified.

The *AlarmIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AlarmCount](#alarmcount-property-caldav-component) property.

## Data Type

**string**

# AlarmMessage Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) AlarmMessage(AlarmIndex int32) (string, error)func (obj *CalDAV) SetAlarmMessage(AlarmIndex int32, value string) error
```

## Default Value

""

## Remarks

This property contains a message used to alert the user when this alarm is triggered. If the [AlarmAction](#alarmaction-property-caldav-component) is set to *aDisplay*, this property must contain the message that is to be displayed to the user. If [AlarmAction](#alarmaction-property-caldav-component) is set to *aEmail* this property will contain the message body of the email that is sent to the [AlarmRecipient](#alarmrecipient-property-caldav-component). For instance:

```text
  CalDAV.Alarm.Action = aEmail;
  CalDAV.Alarm.Recipient = "mailto:john_doe@example.com";
  CalDAV.Alarm.Message = "A draft agenda needs to be sent out to the attendees to the weekly managers meeting (MGR-LIST).";
  CalDAV.Alarm.Subject = "REMINDER: Send agenda for weekly staff meeting.";
```

 or

```text
  CalDAV.Alarm.Action = aDisplay;
  CalDAV.Alarm.Message = "REMINDER: Send agenda for weekly staff meeting.";
```

 [AlarmMessage](#alarmmessage-property-caldav-component) is not used for the *aAudio* alarm [AlarmAction](#alarmaction-property-caldav-component).

The *AlarmIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AlarmCount](#alarmcount-property-caldav-component) property.

## Data Type

**string**

# AlarmRecipient Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) AlarmRecipient(AlarmIndex int32) (string, error)func (obj *CalDAV) SetAlarmRecipient(AlarmIndex int32, value string) error
```

## Default Value

""

## Remarks

This property contains the email address of the person to be alerted when this alarm is triggered. If [AlarmAction](#alarmaction-property-caldav-component) is set to *aEmail* this property must contain one or more comma-separated email addresses to which the email alarm is to be sent. For instance:

```text
  CalDAV.Alarm.Action = aEmail;
  CalDAV.Alarm.Recipient = "mailto:john_doe@example.com";
  CalDAV.Alarm.Message = "A draft agenda needs to be sent out to the attendees to the weekly managers meeting (MGR-LIST).";
  CalDAV.Alarm.Subject = "REMINDER: Send agenda for weekly staff meeting.";
```

 [AlarmRecipient](#alarmrecipient-property-caldav-component) is not used for the *aAudio* or *aDisplay* alarm [AlarmAction](#alarmaction-property-caldav-component)s.

The *AlarmIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AlarmCount](#alarmcount-property-caldav-component) property.

## Data Type

**string**

# AlarmRepeat Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) AlarmRepeat(AlarmIndex int32) (int32, error)func (obj *CalDAV) SetAlarmRepeat(AlarmIndex int32, value int32) error
```

## Default Value

0

## Remarks

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

This property defines the number of times an alarm should be repeated after its initial [AlarmTrigger](#alarmtrigger-property-caldav-component). If the alarm triggers more than once, then this property MUST be specified along with the [AlarmDuration](#alarmduration-property-caldav-component) property.

The *AlarmIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AlarmCount](#alarmcount-property-caldav-component) property.

## Data Type

**int32**

# AlarmSubject Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) AlarmSubject(AlarmIndex int32) (string, error)func (obj *CalDAV) SetAlarmSubject(AlarmIndex int32, value string) error
```

## Default Value

""

## Remarks

This property contains the subject of the message used to alert the user when this alarm is triggered. If [AlarmAction](#alarmaction-property-caldav-component) is set to *aEmail* this property will contain the subject the email that is sent to the [AlarmRecipient](#alarmrecipient-property-caldav-component). For instance:

```text
  CalDAV.Alarm.Action = aEmail;
  CalDAV.Alarm.Recipient = "mailto:john_doe@example.com";
  CalDAV.Alarm.Message = "A draft agenda needs to be sent out to the attendees to the weekly managers meeting (MGR-LIST).";
  CalDAV.Alarm.Subject = "REMINDER: Send agenda for weekly staff meeting.";
```

 [AlarmSubject](#alarmsubject-property-caldav-component) is not used for the *aAudio* or *aDisplay* alarm [AlarmAction](#alarmaction-property-caldav-component)s.

The *AlarmIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AlarmCount](#alarmcount-property-caldav-component) property.

## Data Type

**string**

# AlarmTrigger Property ([CalDAV](#caldav-component) Component)

This property contains the time when the alarm is triggered.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) AlarmTrigger(AlarmIndex int32) (string, error)func (obj *CalDAV) SetAlarmTrigger(AlarmIndex int32, value string) error
```

## Default Value

""

## Remarks

This property contains the time when the alarm is triggered.

The [AlarmTrigger](#alarmtrigger-property-caldav-component) is represented as a duration relative to the start of an event. The format is (+/-)**P**<date>**T**<time>. The **date** component may contain a number of days or weeks (but not months or years), and the **time** component may consist of hours, minutes, and seconds. These are represented by an integer value followed by a letter representing the units, as specified by the table below:

|  |  |
| --- | --- |
| P | is the duration designator (historically called "period") placed at the start of the duration representation. |
| W | is the week designator that follows the value for the number of weeks. |
| D | is the day designator that follows the value for the number of days. |
| T | is the time designator that precedes the time components of the representation. |
| H | is the hour designator that follows the value for the number of hours. |
| M | is the minute designator that follows the value for the number of minutes. |
| S | is the second designator that follows the value for the number of seconds. |

 Either a positive or negative duration may be specified for the [AlarmTrigger](#alarmtrigger-property-caldav-component) property. An alarm with a positive duration is triggered after the associated start of the event (or to-do). An alarm with a negative duration is triggered before the start of the event. For instance, the following code instructs an alarm to fire 10 minutes before the event starts:

```text
  CalDAV.Alarm.Trigger = "-PT10M"
```

The *AlarmIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AlarmCount](#alarmcount-property-caldav-component) property.

## Data Type

**string**

# Attendees Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Attendees() (string, error)func (obj *CalDAV) SetAttendees(value string) error
```

## 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:

```csharp
  CalDAV.Attendees = "mailto:johnsmith@example.com,mailto:janedoe@test.com"
```

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# Authorization Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Authorization() (string, error)func (obj *CalDAV) SetAuthorization(value string) error
```

## 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 struct can be extended with other security schemes in addition to the authorization schemes already implemented by the struct.

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

## Data Type

**string**

# AuthScheme Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) AuthScheme() (int32, error)func (obj *CalDAV) SetAuthScheme(value int32) error
```

## Possible Values

```text
0   // Basic1   // Digest2   // Proprietary3   // None4   // Ntlm5   // Negotiate6   // OAuth
```

## Default Value

0

## Remarks

This property will tell the struct which type of authorization to perform when the [User](#user-property-caldav-component) and [Password](#password-property-caldav-component) 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](#user-property-caldav-component) and [Password](#password-property-caldav-component) properties are set, the struct 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](#authorization-property-caldav-component) property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the [Authorization](#authorization-property-caldav-component) property.

NOTE: If you set the [Authorization](#authorization-property-caldav-component) property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the struct.

For security, changing the value of this property will cause the struct to clear the values of [User](#user-property-caldav-component), [Password](#password-property-caldav-component), and [Authorization](#Authorization).

## Data Type

**int32**

# CalendarCount Property ([CalDAV](#caldav-component) Component)

The number of records in the Calendar arrays.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CalendarCount() (int32, error)func (obj *CalDAV) SetCalendarCount(value int32) error
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [CalendarColor](#calendarcolor-property-caldav-component)
- [CalendarCTag](#calendarctag-property-caldav-component)
- [CalendarDescription](#calendardescription-property-caldav-component)
- [CalendarDisplayName](#calendardisplayname-property-caldav-component)
- [CalendarPropertyCount](#calendarpropertycount-property-caldav-component)
- [CalendarPropertyIndex](#calendarpropertyindex-property-caldav-component)
- [CalendarPropertyName](#calendarpropertyname-property-caldav-component)
- [CalendarPropertyValue](#calendarpropertyvalue-property-caldav-component)
- [CalendarURL](#calendarurl-property-caldav-component)

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

## Data Type

**int32**

# CalendarColor Property ([CalDAV](#caldav-component) Component)

This property specifies the calendar's color.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CalendarColor(CalendarIndex int32) (string, error)func (obj *CalDAV) SetCalendarColor(CalendarIndex int32, value string) error
```

## Default Value

""

## Remarks

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

The *CalendarIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CalendarCount](#calendarcount-property-caldav-component) property.

## Data Type

**string**

# CalendarCTag Property ([CalDAV](#caldav-component) Component)

This property holds the current ctag of the calendar.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CalendarCTag(CalendarIndex int32) (string, error)func (obj *CalDAV) SetCalendarCTag(CalendarIndex int32, value string) error
```

## Default Value

""

## Remarks

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

The *CalendarIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CalendarCount](#calendarcount-property-caldav-component) property.

## Data Type

**string**

# CalendarDescription Property ([CalDAV](#caldav-component) Component)

This property holds the description of the calendar.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CalendarDescription(CalendarIndex int32) (string, error)func (obj *CalDAV) SetCalendarDescription(CalendarIndex int32, value string) error
```

## Default Value

""

## Remarks

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

The *CalendarIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CalendarCount](#calendarcount-property-caldav-component) property.

## Data Type

**string**

# CalendarDisplayName Property ([CalDAV](#caldav-component) Component)

This property holds the display name of the calendar.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CalendarDisplayName(CalendarIndex int32) (string, error)func (obj *CalDAV) SetCalendarDisplayName(CalendarIndex int32, value string) error
```

## Default Value

""

## Remarks

This property holds the display name of the calendar.

The *CalendarIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CalendarCount](#calendarcount-property-caldav-component) property.

## Data Type

**string**

# CalendarPropertyCount Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CalendarPropertyCount(CalendarIndex int32) (int32, error)
```

## Default Value

0

## Remarks

This property holds the total number of properties of the calendar. This property, in conjunction with [CalendarPropertyIndex](#calendarpropertyindex-property-caldav-component), [CalendarPropertyName](#calendarpropertyname-property-caldav-component) and [CalendarPropertyValue](#calendarpropertyvalue-property-caldav-component) provide a way to obtain additional property values that do not correspond to existing properties. For instance:

```csharp
for (int i = 0; i < component.Calendars[0].PropertyCount; i++) {

  //Setting PropertyIndex selects the property
  component.Calendars[0].PropertyIndex = i;

  //After selecting the property by setting PropertyIndex output the property name and value
  Console.WriteLine(component.Calendars[0].PropertyName + ": " + component.Calendars[0].PropertyValue);
}
```

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

The *CalendarIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CalendarCount](#calendarcount-property-caldav-component) property.

This property is read-only.

## Data Type

**int32**

# CalendarPropertyIndex Property ([CalDAV](#caldav-component) Component)

This property specifies the currently selected property.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CalendarPropertyIndex(CalendarIndex int32) (int32, error)func (obj *CalDAV) SetCalendarPropertyIndex(CalendarIndex int32, value int32) error
```

## Default Value

0

## Remarks

This property specifies the currently selected property. Please see [CalendarPropertyCount](#calendarpropertycount-property-caldav-component) for details.

The *CalendarIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CalendarCount](#calendarcount-property-caldav-component) property.

## Data Type

**int32**

# CalendarPropertyName Property ([CalDAV](#caldav-component) Component)

This property holds the name of the currently selected property.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CalendarPropertyName(CalendarIndex int32) (string, error)
```

## Default Value

"0"

## Remarks

This property holds the name of the currently selected property. Please see [CalendarPropertyCount](#calendarpropertycount-property-caldav-component) for details.

The *CalendarIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CalendarCount](#calendarcount-property-caldav-component) property.

This property is read-only.

## Data Type

**string**

# CalendarPropertyValue Property ([CalDAV](#caldav-component) Component)

This property holds the value of the currently selected property.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CalendarPropertyValue(CalendarIndex int32) (string, error)
```

## Default Value

""

## Remarks

This property holds the value of the currently selected property. Please see [CalendarPropertyCount](#calendarpropertycount-property-caldav-component) for details.

The *CalendarIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CalendarCount](#calendarcount-property-caldav-component) property.

This property is read-only.

## Data Type

**string**

# CalendarURL Property ([CalDAV](#caldav-component) Component)

This property provides the URL of the calendar.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CalendarURL(CalendarIndex int32) (string, error)func (obj *CalDAV) SetCalendarURL(CalendarIndex int32, value string) error
```

## Default Value

""

## Remarks

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

The *CalendarIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CalendarCount](#calendarcount-property-caldav-component) property.

## Data Type

**string**

# Categories Property ([CalDAV](#caldav-component) Component)

Used to specify categories or subtypes of the calendar event.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Categories() (string, error)func (obj *CalDAV) SetCategories(value string) error
```

## 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:

```csharp
  CalDAV.CalendarEvents[0].Category = "APPOINTMENT,EDUCATION,MEETING";
```

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# Classification Property ([CalDAV](#caldav-component) Component)

Defines the access classification for a calendar class.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Classification() (string, error)func (obj *CalDAV) SetClassification(value string) error
```

## Default Value

""

## Remarks

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

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# Completed Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Completed() (string, error)func (obj *CalDAV) SetCompleted(value string) error
```

## 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](#eventtype-property-caldav-component). The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# Connected Property ([CalDAV](#caldav-component) Component)

Whether the class is connected.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Connected() (bool, error)
```

## Default Value

false

## Remarks

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

This property is read-only.

## Data Type

**bool**

# CookieCount Property ([CalDAV](#caldav-component) Component)

The number of records in the Cookie arrays.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CookieCount() (int32, error)func (obj *CalDAV) SetCookieCount(value int32) error
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [CookieDomain](#cookiedomain-property-caldav-component)
- [CookieExpiration](#cookieexpiration-property-caldav-component)
- [CookieName](#cookiename-property-caldav-component)
- [CookiePath](#cookiepath-property-caldav-component)
- [CookieSecure](#cookiesecure-property-caldav-component)
- [CookieValue](#cookievalue-property-caldav-component)

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

## Data Type

**int32**

# CookieDomain Property ([CalDAV](#caldav-component) Component)

The domain of a received cookie.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CookieDomain(CookieIndex int32) (string, error)
```

## Default Value

""

## Remarks

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

The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-caldav-component) property.

This property is read-only.

## Data Type

**string**

# CookieExpiration Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CookieExpiration(CookieIndex int32) (string, error)
```

## Default Value

""

## Remarks

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

The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-caldav-component) property.

This property is read-only.

## Data Type

**string**

# CookieName Property ([CalDAV](#caldav-component) Component)

The name of the cookie.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CookieName(CookieIndex int32) (string, error)func (obj *CalDAV) SetCookieName(CookieIndex int32, value string) error
```

## Default Value

""

## Remarks

The name of the cookie.

This property, along with [CookieValue](#cookievalue-property-caldav-component), stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.

The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-caldav-component) property.

## Data Type

**string**

# CookiePath Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CookiePath(CookieIndex int32) (string, error)
```

## Default Value

""

## Remarks

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

The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-caldav-component) property.

This property is read-only.

## Data Type

**string**

# CookieSecure Property ([CalDAV](#caldav-component) Component)

The security flag of the received cookie.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CookieSecure(CookieIndex int32) (bool, error)
```

## Default Value

false

## Remarks

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

The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-caldav-component) property.

This property is read-only.

## Data Type

**bool**

# CookieValue Property ([CalDAV](#caldav-component) Component)

The value of the cookie.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CookieValue(CookieIndex int32) (string, error)func (obj *CalDAV) SetCookieValue(CookieIndex int32, value string) error
```

## Default Value

""

## Remarks

The value of the cookie. A corresponding value is associated with the cookie specified by [CookieName](#cookiename-property-caldav-component). This property holds that value.

The SetCookie event provides the cookies set by the server.

The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-caldav-component) property.

## Data Type

**string**

# CustomPropertyCount Property ([CalDAV](#caldav-component) Component)

The number of records in the CustomProperty arrays.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CustomPropertyCount() (int32, error)func (obj *CalDAV) SetCustomPropertyCount(value int32) error
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [CustomPropertyAttribute](#custompropertyattribute-property-caldav-component)
- [CustomPropertyName](#custompropertyname-property-caldav-component)
- [CustomPropertyValue](#custompropertyvalue-property-caldav-component)

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

## Data Type

**int32**

# CustomPropertyAttribute Property ([CalDAV](#caldav-component) Component)

This property contains an optional attribute of the custom property.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CustomPropertyAttribute(CustomPropertyIndex int32) (string, error)func (obj *CalDAV) SetCustomPropertyAttribute(CustomPropertyIndex int32, value string) error
```

## Default Value

""

## Remarks

This property contains an optional attribute of the custom property.

The *CustomPropertyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CustomPropertyCount](#custompropertycount-property-caldav-component) property.

## Data Type

**string**

# CustomPropertyName Property ([CalDAV](#caldav-component) Component)

This property contains the textual name of the custom property.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CustomPropertyName(CustomPropertyIndex int32) (string, error)func (obj *CalDAV) SetCustomPropertyName(CustomPropertyIndex int32, value string) error
```

## Default Value

""

## Remarks

This property contains the textual name of the custom property.

The *CustomPropertyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CustomPropertyCount](#custompropertycount-property-caldav-component) property.

## Data Type

**string**

# CustomPropertyValue Property ([CalDAV](#caldav-component) Component)

This property contains the value of the custom property.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CustomPropertyValue(CustomPropertyIndex int32) (string, error)func (obj *CalDAV) SetCustomPropertyValue(CustomPropertyIndex int32, value string) error
```

## Default Value

""

## Remarks

This property contains the value of the custom property.

The *CustomPropertyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CustomPropertyCount](#custompropertycount-property-caldav-component) property.

## Data Type

**string**

# Description Property ([CalDAV](#caldav-component) Component)

Provides a complete description of the calendar event.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Description() (string, error)func (obj *CalDAV) SetDescription(value string) error
```

## Default Value

""

## Remarks

This property provides a more complete description of the event than is provided by the [Summary](#summary-property-caldav-component) property.

## Data Type

**string**

# DueDate Property ([CalDAV](#caldav-component) Component)

Specifies the due date for a calendar event.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) DueDate() (string, error)func (obj *CalDAV) SetDueDate(value string) error
```

## 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](#enddate-property-caldav-component).

## Data Type

**string**

# Duration Property ([CalDAV](#caldav-component) Component)

Duration of the calendar event.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Duration() (string, error)func (obj *CalDAV) SetDuration(value string) error
```

## 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:

|  |  |
| --- | --- |
| P | is the duration designator (historically called "period") placed at the start of the duration representation. |
| W | is the week designator that follows the value for the number of weeks. |
| D | is the day designator that follows the value for the number of days. |
| T | is the time designator that precedes the time components of the representation. |
| H | is the hour designator that follows the value for the number of hours. |
| M | is the minute designator that follows the value for the number of minutes. |
| S | is the second designator that follows the value for the number of seconds. |

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

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

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# EndDate Property ([CalDAV](#caldav-component) Component)

Specifies the date and time that a calendar event ends.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) EndDate() (string, error)func (obj *CalDAV) SetEndDate(value string) error
```

## Default Value

""

## Remarks

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

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# ETag Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ETag() (string, error)func (obj *CalDAV) SetETag(value string) error
```

## Default Value

""

## Remarks

This property identifies the state of the event in the calendar. An ETag is returned by the CalDAV server after a successful [CreateEvent](#createevent-method-caldav-component) 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](#getcalendarreport-method-caldav-component) request with the [ReportFilterReturnCalendarData](#reportfilterreturncalendardata-property-caldav-component) property set to False only the URI and ETags for each event in the calendar will be returned in the report. You can cache the ETag and URI locally, and then inspect the report for any changes and update only the events that have changed ETags.

When updating an event with the [CreateEvent](#createevent-method-caldav-component) method, you may add the ETag to the "If-Match" header (using [OtherHeaders](#otherheaders-property-caldav-component)) in order to insure that you are not overwriting more recent changes on the server. For instance:

```csharp
  calDAV.UID = "20110202T000000Z-6414-500-10112-204@nsoftest";
  calDAV.StartDate = "20110202T000000Z";
  calDAV.EndDate = "20110202T110000Z";
  calDAV.TimeStamp = "20100301T000000Z";
  calDAV.Summary = "Dinner with friends";
  calDAV.Description = "Getting everyone together for some food and fun";
  calDAV.Location = "The James Joyce Irish Pub";
  calDAV.EventType = CaldavsEventTypes.vEvent;
  calDAV.OtherHeaders = "If-Match: 1900-1900\r\ n";
  calDAV.CreateEvent "https://caldav.calendar.yahoo.com/dav/user_name/Calendar/My_Calendar/20110202T000000Z-6414-500-10112-204@nsoftest.ics"
```

 If the current ETag for the above event is "1900-1900", then the above modification will work perfectly. However, if the event was modified on the Yahoo server, the ETag will not match and the above will fail with an HTTP Protocol error: "409 Conflict". In that case you should retrieve the event with [GetEvent](#getevent-method-caldav-component) and update the most recent version.

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# EventType Property ([CalDAV](#caldav-component) Component)

Indicates the type of calendar object resource.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) EventType() (int32, error)func (obj *CalDAV) SetEventType(value int32) error
```

## Possible Values

```text
0   // Event1   // Todo2   // Journal3   // FreeBusy
```

## Default Value

0

## Remarks

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

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**int32**

# FirewallAutoDetect Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) FirewallAutoDetect() (bool, error)func (obj *CalDAV) SetFirewallAutoDetect(value bool) error
```

## Default Value

false

## Remarks

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

## Data Type

**bool**

# FirewallType Property ([CalDAV](#caldav-component) Component)

The type of firewall to connect through.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) FirewallType() (int32, error)func (obj *CalDAV) SetFirewallType(value int32) error
```

## Possible Values

```text
0   // None1   // Tunnel2   // SOCKS43   // SOCKS510   // SOCKS4A
```

## Default Value

0

## Remarks

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

|  |  |
| --- | --- |
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. [FirewallPort](#firewallport-property-caldav-component) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [FirewallPort](#firewallport-property-caldav-component) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [FirewallPort](#firewallport-property-caldav-component) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [FirewallPort](#firewallport-property-caldav-component) is set to 1080. |

## Data Type

**int32**

# FirewallHost Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) FirewallHost() (string, error)func (obj *CalDAV) SetFirewallHost(value string) error
```

## Default Value

""

## Remarks

The name or IP address of the firewall (optional). If a [FirewallHost](#firewallhost-property-caldav-component) is given, the requested connections will be authenticated through the specified firewall when connecting.

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

## Data Type

**string**

# FirewallPassword Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) FirewallPassword() (string, error)func (obj *CalDAV) SetFirewallPassword(value string) error
```

## Default Value

""

## Remarks

A password if authentication is to be used when connecting through the firewall. If [FirewallHost](#firewallhost-property-caldav-component) is specified, the [FirewallUser](#firewalluser-property-caldav-component) and [FirewallPassword](#firewallpassword-property-caldav-component) properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

## Data Type

**string**

# FirewallPort Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) FirewallPort() (int32, error)func (obj *CalDAV) SetFirewallPort(value int32) error
```

## Default Value

0

## Remarks

The Transmission Control Protocol (TCP) port for the firewall [FirewallHost](#firewallhost-property-caldav-component). See the description of the [FirewallHost](#firewallhost-property-caldav-component) property for details.

NOTE: This property is set automatically when [FirewallType](#firewalltype-property-caldav-component) is set to a valid value. See the description of the [FirewallType](#firewalltype-property-caldav-component) property for details.

## Data Type

**int32**

# FirewallUser Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) FirewallUser() (string, error)func (obj *CalDAV) SetFirewallUser(value string) error
```

## Default Value

""

## Remarks

A username if authentication is to be used when connecting through a firewall. If [FirewallHost](#firewallhost-property-caldav-component) is specified, this property and the [FirewallPassword](#firewallpassword-property-caldav-component) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the struct fails with an error.

## Data Type

**string**

# FollowRedirects Property ([CalDAV](#caldav-component) Component)

Determines what happens when the server issues a redirect.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) FollowRedirects() (int32, error)func (obj *CalDAV) SetFollowRedirects(value int32) error
```

## Possible Values

```text
0   // Never1   // Always2   // SameScheme
```

## Default Value

0

## Remarks

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

If this property is set to frSameScheme (2), the new [URL](#url-property-caldav-component) is retrieved automatically only if the URLScheme is the same; otherwise, the struct fails with an error.

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

Furthermore, if either the new URL server or port are different from the existing one, [User](#user-property-caldav-component) and [Password](#password-property-caldav-component) 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](#redirect-event-caldav-component) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [Redirect](#redirect-event-caldav-component) 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 struct fails with an error instead.

## Data Type

**int32**

# FreeBusyCount Property ([CalDAV](#caldav-component) Component)

The number of records in the FreeBusy arrays.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) FreeBusyCount() (int32, error)
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [FreeBusyRange](#freebusyrange-property-caldav-component)
- [FreeBusyType](#freebusytype-property-caldav-component)

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

This property is read-only.

## Data Type

**int32**

# FreeBusyRange Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) FreeBusyRange(FreeBusyIndex int32) (string, error)
```

## Default Value

""

## Remarks

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

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

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

|  |  |
| --- | --- |
| P | is the duration designator (historically called "period") placed at the start of the duration representation. |
| W | is the week designator that follows the value for the number of weeks. |
| D | is the day designator that follows the value for the number of days. |
| T | is the time designator that precedes the time components of the representation. |
| H | is the hour designator that follows the value for the number of hours. |
| M | is the minute designator that follows the value for the number of minutes. |
| S | is the second designator that follows the value for the number of seconds. |

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

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

The *FreeBusyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FreeBusyCount](#freebusycount-property-caldav-component) property.

This property is read-only.

## Data Type

**string**

# FreeBusyType Property ([CalDAV](#caldav-component) Component)

Indicates the busy status of the corresponding BusyRange .

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) FreeBusyType(FreeBusyIndex int32) (string, error)
```

## Default Value

""

## Remarks

Indicates the busy status of the corresponding [FreeBusyBusyRange](#CalDAV_p_FreeBusyBusyRange). A calendar may use custom values for the [FreeBusyBusyType](#CalDAV_p_FreeBusyBusyType), but the standard values include:

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

The *FreeBusyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FreeBusyCount](#freebusycount-property-caldav-component) property.

This property is read-only.

## Data Type

**string**

# Idle Property ([CalDAV](#caldav-component) Component)

The current status of the class.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Idle() (bool, error)
```

## Default Value

true

## Remarks

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

This property is read-only.

## Data Type

**bool**

# LastModified Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) LastModified() (string, error)func (obj *CalDAV) SetLastModified(value string) error
```

## Default Value

""

## Remarks

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

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# LocalHost Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) LocalHost() (string, error)func (obj *CalDAV) SetLocalHost(value string) error
```

## Default Value

""

## Remarks

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

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

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

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

## Data Type

**string**

# Location Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Location() (string, error)func (obj *CalDAV) SetLocation(value string) error
```

## Default Value

""

## Remarks

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

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# LockType Property ([CalDAV](#caldav-component) Component)

The type of the current resource lock.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) LockType() (string, error)func (obj *CalDAV) SetLockType(value string) error
```

## Default Value

"write"

## Remarks

The type of the current resource lock.

Before the calendar resource can be locked, the [LockType](#locktype-property-caldav-component) may be set to the type of lock being requested. Currently, the struct only supports requesting locks of type "write", although the protocol defines an optional "read" lock. After a successful **LockCalendar** operation, the struct will set the [LockType](#locktype-property-caldav-component) property to the correct value returned in the server's response.

## Data Type

**string**

# LockOwner Property ([CalDAV](#caldav-component) Component)

The principle that owns the current resource lock.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) LockOwner() (string, error)func (obj *CalDAV) SetLockOwner(value string) error
```

## Default Value

""

## Remarks

The principle that owns the current resource lock.

Before the calendar resource can be locked, the Lock [LockOwner](#lockowner-property-caldav-component) may be set to the name of a principle or group of principles that will own the lock. If no owner is specified, the server will automatically associate the lock with the requesting principle. After a successful **LockCalendar** operation, the struct will set the [LockOwner](#lockowner-property-caldav-component) property to the correct value returned in the server's response.

## Data Type

**string**

# LockScope Property ([CalDAV](#caldav-component) Component)

The scope of the current resource lock.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) LockScope() (string, error)func (obj *CalDAV) SetLockScope(value string) error
```

## Default Value

""

## Remarks

The scope of the current resource lock.

 Before the calendar resource can be locked, the Lock [LockScope](#lockscope-property-caldav-component) may be set to the type of scope needed for the lock. Currently the struct will only allow two types of scopes to be requested:

|  |  |
| --- | --- |
| "exclusive" | The lock belongs exclusively to the requesting principle. No other principle may modify the locked resource URI. |
| "shared" | The locked resource may not be modified by non-trusted principles. Users who have access rights, however, may request a shared lock which they can then use to modify or operate on the resource. |

If no scope is specified, the protocol default scope, "exclusive", will be requested. After a successful **LockCalendar** operation, the struct will set the [LockScope](#lockscope-property-caldav-component) property to the correct value returned in the server's response.

## Data Type

**string**

# LockTimeout Property ([CalDAV](#caldav-component) Component)

The time to live for the current resource lock.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) LockTimeout() (int32, error)func (obj *CalDAV) SetLockTimeout(value int32) error
```

## Default Value

0

## Remarks

The time to live for the current resource lock.

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

## Data Type

**int32**

# LockToken Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) LockToken() (string, error)func (obj *CalDAV) SetLockToken(value string) error
```

## Default Value

""

## Remarks

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

Before the calendar resource can be locked, the Lock [LockToken](#locktoken-property-caldav-component) may be set to the token returned by a previous lock operation. This is useful when renewing a timeout. The server will respond with a new timeout value, which will be stored in [LockTimeout](#locktimeout-property-caldav-component). If the lock request is not a lock refresh, [LockToken](#locktoken-property-caldav-component) must be empty, and will be parsed out of the server response after a successful **LockCalendar** operation.

## Data Type

**string**

# Organizer Property ([CalDAV](#caldav-component) Component)

Defines the organizer of a calendar event.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Organizer() (string, error)func (obj *CalDAV) SetOrganizer(value string) error
```

## Default Value

""

## Remarks

This property is specified within the *vEvent*, *vTodo*, and *vJournal* calendar [EventType](#eventtype-property-caldav-component)s to specify the organizer of a group-scheduled calendar entity. The property is specified within the *vFreeBusy* [EventType](#eventtype-property-caldav-component) to identify the calendar user requesting the free or busy time. When publishing a *vFreeBusy* [EventType](#eventtype-property-caldav-component), 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:

```csharp
  CalDAV.Organizer = "mailto:jane_doe@example.com";
```

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# OtherHeaders Property ([CalDAV](#caldav-component) Component)

Other headers as determined by the user (optional).

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) OtherHeaders() (string, error)func (obj *CalDAV) SetOtherHeaders(value string) error
```

## Default Value

""

## Remarks

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

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

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

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

For CalDAV, the "If-Match" header is extremely useful. After adding a an event with [CreateEvent](#createevent-method-caldav-component) or retrieving an event with [GetEvent](#getevent-method-caldav-component), the [ETag](#etag-property-caldav-component) 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](#etag-property-caldav-component) in an "If-Match" header. If the event on the server has been modified since you retrieved it (and the ETag on the server has changed), then the [CreateEvent](#createevent-method-caldav-component) 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:

```csharp
  calDAV.OtherHeaders = "If-Match: 1900-1900\r\ n";
```

## Data Type

**string**

# ParsedHeaderCount Property ([CalDAV](#caldav-component) Component)

The number of records in the ParsedHeader arrays.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ParsedHeaderCount() (int32, error)
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [ParsedHeaderField](#parsedheaderfield-property-caldav-component)
- [ParsedHeaderValue](#parsedheadervalue-property-caldav-component)

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

This property is read-only.

## Data Type

**int32**

# ParsedHeaderField Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ParsedHeaderField(ParsedHeaderIndex int32) (string, error)
```

## Default Value

""

## Remarks

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

The *ParsedHeaderIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ParsedHeaderCount](#parsedheadercount-property-caldav-component) property.

This property is read-only.

## Data Type

**string**

# ParsedHeaderValue Property ([CalDAV](#caldav-component) Component)

This property contains the header contents.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ParsedHeaderValue(ParsedHeaderIndex int32) (string, error)
```

## Default Value

""

## Remarks

This property contains the [Header](#Type_Header) contents.

The *ParsedHeaderIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ParsedHeaderCount](#parsedheadercount-property-caldav-component) property.

This property is read-only.

## Data Type

**string**

# Password Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Password() (string, error)func (obj *CalDAV) SetPassword(value string) error
```

## Default Value

""

## Remarks

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

If [AuthScheme](#authscheme-property-caldav-component) is set to HTTP Digest Authentication, the [User](#user-property-caldav-component) and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If [AuthScheme](#authscheme-property-caldav-component) is set to NTLM, NTLM authentication will be attempted. If [AuthScheme](#authscheme-property-caldav-component) is set to NTLM and [User](#user-property-caldav-component) and Password are empty, the struct will attempt to authenticate using the current user's credentials.

## Data Type

**string**

# Priority Property ([CalDAV](#caldav-component) Component)

Defines the relative priority for a calendar event.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Priority() (int32, error)func (obj *CalDAV) SetPriority(value int32) error
```

## Default Value

0

## Remarks

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

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

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**int32**

# ProxyAuthScheme Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ProxyAuthScheme() (int32, error)func (obj *CalDAV) SetProxyAuthScheme(value int32) error
```

## Possible Values

```text
0   // Basic1   // Digest2   // Proprietary3   // None4   // Ntlm5   // Negotiate
```

## Default Value

0

## Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the [ProxyUser](#proxyuser-property-caldav-component) and [ProxyPassword](#proxypassword-property-caldav-component) properties are set.

[ProxyAuthScheme](#proxyauthscheme-property-caldav-component) should be set to authNone (3) when no authentication is expected.

By default, [ProxyAuthScheme](#proxyauthscheme-property-caldav-component) is authBasic (0), and if the [ProxyUser](#proxyuser-property-caldav-component) and [ProxyPassword](#proxypassword-property-caldav-component) properties are set, the struct will attempt basic authentication.

If [ProxyAuthScheme](#proxyauthscheme-property-caldav-component) is set to authDigest (1), digest authentication will be attempted instead.

If [ProxyAuthScheme](#proxyauthscheme-property-caldav-component) is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token.

If [ProxyAuthScheme](#proxyauthscheme-property-caldav-component) is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of [ProxyUser](#proxyuser-property-caldav-component) and [ProxyPassword](#proxypassword-property-caldav-component).

## Data Type

**int32**

# ProxyAutoDetect Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ProxyAutoDetect() (bool, error)func (obj *CalDAV) SetProxyAutoDetect(value bool) error
```

## Default Value

false

## Remarks

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

## Data Type

**bool**

# ProxyPassword Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ProxyPassword() (string, error)func (obj *CalDAV) SetProxyPassword(value string) error
```

## Default Value

""

## Remarks

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

If [ProxyAuthScheme](#proxyauthscheme-property-caldav-component) is set to Basic Authentication, the [ProxyUser](#proxyuser-property-caldav-component) and [ProxyPassword](#proxypassword-property-caldav-component) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [ProxyAuthScheme](#proxyauthscheme-property-caldav-component) is set to Digest Authentication, the [ProxyUser](#proxyuser-property-caldav-component) and [ProxyPassword](#proxypassword-property-caldav-component) properties are used to respond to the Digest Authentication challenge from the server.

If [ProxyAuthScheme](#proxyauthscheme-property-caldav-component) is set to NTLM Authentication, the [ProxyUser](#proxyuser-property-caldav-component) and [ProxyPassword](#proxypassword-property-caldav-component) properties are used to authenticate through NTLM negotiation.

## Data Type

**string**

# ProxyPort Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ProxyPort() (int32, error)func (obj *CalDAV) SetProxyPort(value int32) error
```

## Default Value

80

## Remarks

The Transmission Control Protocol (TCP) port for the proxy [ProxyServer](#proxyserver-property-caldav-component) (default 80). See the description of the [ProxyServer](#proxyserver-property-caldav-component) property for details.

## Data Type

**int32**

# ProxyServer Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ProxyServer() (string, error)func (obj *CalDAV) SetProxyServer(value string) error
```

## Default Value

""

## Remarks

If a proxy [ProxyServer](#proxyserver-property-caldav-component) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the [ProxyServer](#proxyserver-property-caldav-component) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [ProxyServer](#proxyserver-property-caldav-component) property is set to the corresponding address. If the search is not successful, an error is returned.

## Data Type

**string**

# ProxySSL Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ProxySSL() (int32, error)func (obj *CalDAV) SetProxySSL(value int32) error
```

## Possible Values

```text
0   // Automatic1   // Always2   // Never3   // Tunnel
```

## Default Value

0

## Remarks

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

|  |  |
| --- | --- |
| psAutomatic (0) | Default setting. If the URL is an https URL, the struct will use the psTunnel option. If the URL is an http URL, the struct will use the psNever option. |
| psAlways (1) | The connection is always SSL-enabled. |
| psNever (2) | The connection is not SSL-enabled. |
| psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |

## Data Type

**int32**

# ProxyUser Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ProxyUser() (string, error)func (obj *CalDAV) SetProxyUser(value string) error
```

## Default Value

""

## Remarks

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

If [ProxyAuthScheme](#proxyauthscheme-property-caldav-component) is set to Basic Authentication, the [ProxyUser](#proxyuser-property-caldav-component) and [ProxyPassword](#proxypassword-property-caldav-component) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [ProxyAuthScheme](#proxyauthscheme-property-caldav-component) is set to Digest Authentication, the [ProxyUser](#proxyuser-property-caldav-component) and [ProxyPassword](#proxypassword-property-caldav-component) properties are used to respond to the Digest Authentication challenge from the server.

If [ProxyAuthScheme](#proxyauthscheme-property-caldav-component) is set to NTLM Authentication, the [ProxyUser](#proxyuser-property-caldav-component) and [ProxyPassword](#proxypassword-property-caldav-component) properties are used to authenticate through NTLM negotiation.

## Data Type

**string**

# RecurrenceDates Property ([CalDAV](#caldav-component) Component)

Individual dates on which the event will recur.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) RecurrenceDates() (string, error)func (obj *CalDAV) SetRecurrenceDates(value string) error
```

## Default Value

""

## Remarks

Individual dates on which the event will recur.

This property is used if you wish to denote specific, individual dates on which the event recurs. If you have an event that occurs monthly or weekly or on some other time interval, use the [RecurrenceRule](#recurrencerule-property-caldav-component) property instead.

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the [CalDAV](#caldav-component) **EventDetails** event.

## Data Type

**string**

# RecurrenceExceptionDates Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) RecurrenceExceptionDates() (string, error)func (obj *CalDAV) SetRecurrenceExceptionDates(value string) error
```

## Default Value

""

## Remarks

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

If the [RecurrenceExceptionDates](#recurrenceexceptiondates-property-caldav-component) and [RecurrenceExceptionRule](#recurrenceexceptionrule-property-caldav-component) are specified, they are used in computing the recurrence set. The recurrence set is the complete set of recurrence instances for a calendar component. The recurrence set is generated by considering the initial StartDate property along with the [RecurrenceRule](#recurrencerule-property-caldav-component), [RecurrenceDates](#recurrencedates-property-caldav-component), [RecurrenceExceptionRule](#recurrenceexceptionrule-property-caldav-component), and [RecurrenceExceptionDates](#recurrenceexceptiondates-property-caldav-component) properties contained within the recurring event. The StartDate property defines the first instance in the recurrence set. The starting date SHOULD match the pattern of the recurrence rule, if specified. The recurrence set generated with a start date that doesn't match the pattern of the rule is undefined. The final recurrence set is generated by gathering all of the start DATE-TIME values generated by any of the specified [RecurrenceRule](#recurrencerule-property-caldav-component) and [RecurrenceDates](#recurrencedates-property-caldav-component) properties, and then excluding any start DATE-TIME values specified by the [RecurrenceExceptionRule](#recurrenceexceptionrule-property-caldav-component) or [RecurrenceExceptionDates](#recurrenceexceptiondates-property-caldav-component) properties. This implies that DATE-TIME values specified by the [RecurrenceExceptionRule](#recurrenceexceptionrule-property-caldav-component) and [RecurrenceExceptionDates](#recurrenceexceptiondates-property-caldav-component) properties take precedence over those specified by inclusion properties (i.e., [RecurrenceDates](#recurrencedates-property-caldav-component) and [RecurrenceRule](#recurrencerule-property-caldav-component)). When duplicate instances are generated by the recurrence [RecurrenceRule](#recurrencerule-property-caldav-component) and [RecurrenceDates](#recurrencedates-property-caldav-component) properties, only one recurrence is considered. Duplicate instances are ignored.

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

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the [CalDAV](#caldav-component) **EventDetails** event.

## Data Type

**string**

# RecurrenceExceptionRule Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) RecurrenceExceptionRule() (string, error)func (obj *CalDAV) SetRecurrenceExceptionRule(value string) error
```

## Default Value

""

## Remarks

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

If the [RecurrenceExceptionDates](#recurrenceexceptiondates-property-caldav-component) and [RecurrenceExceptionRule](#recurrenceexceptionrule-property-caldav-component) are specified, they are used in computing the recurrence set. The recurrence set is the complete set of recurrence instances for a calendar component. The recurrence set is generated by considering the initial StartDate property along with the [RecurrenceRule](#recurrencerule-property-caldav-component), [RecurrenceDates](#recurrencedates-property-caldav-component), [RecurrenceExceptionRule](#recurrenceexceptionrule-property-caldav-component), and [RecurrenceExceptionDates](#recurrenceexceptiondates-property-caldav-component) properties contained within the recurring event. The StartDate property defines the first instance in the recurrence set. The starting date SHOULD match the pattern of the recurrence rule, if specified. The recurrence set generated with a start date that doesn't match the pattern of the rule is undefined. The final recurrence set is generated by gathering all of the start DATE-TIME values generated by any of the specified [RecurrenceRule](#recurrencerule-property-caldav-component) and [RecurrenceDates](#recurrencedates-property-caldav-component) properties, and then excluding any start DATE-TIME values specified by the [RecurrenceExceptionRule](#recurrenceexceptionrule-property-caldav-component) or [RecurrenceExceptionDates](#recurrenceexceptiondates-property-caldav-component) properties. This implies that DATE-TIME values specified by the [RecurrenceExceptionRule](#recurrenceexceptionrule-property-caldav-component) and [RecurrenceExceptionDates](#recurrenceexceptiondates-property-caldav-component) properties take precedence over those specified by inclusion properties (i.e., [RecurrenceDates](#recurrencedates-property-caldav-component) and [RecurrenceRule](#recurrencerule-property-caldav-component)). When duplicate instances are generated by the recurrence [RecurrenceRule](#recurrencerule-property-caldav-component) and [RecurrenceDates](#recurrencedates-property-caldav-component) properties, only one recurrence is considered. Duplicate instances are ignored.

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

The table below shows the supported rules and their usage.

|  |  |
| --- | --- |
| FREQ | The FREQ rule part identifies the type of recurrence rule. This rule part MUST be specified in the recurrence rule. Valid values include SECONDLY, to specify repeating events based on an interval of a second or more; MINUTELY, to specify repeating events based on an interval of a minute or more; HOURLY, to specify repeating events based on an interval of an hour or more; DAILY, to specify repeating events based on an interval of a day or more; WEEKLY, to specify repeating events based on an interval of a week or more; MONTHLY, to specify repeating events based on an interval of a month or more; and YEARLY, to specify repeating events based on an interval of a year or more. |
| UNTIL | The UNTIL rule part defines a DATE (YYYYMMDD) or DATE-TIME (YYYYMMDDThhmmss) value that bounds the recurrence rule in an inclusive manner. If the value specified by UNTIL is synchronized with the specified recurrence, this DATE or DATE-TIME becomes the last instance of the recurrence. The value of the UNTIL rule part MUST have the same value type as the StartDate property. Furthermore, if the StartDate is specified as a date with local time, then the UNTIL rule part MUST also be specified as a date with local time. If the StartDate property is specified as a date with UTC time or a date with local time and time zone reference, then the UNTIL rule part MUST be specified as a date with UTC time. If not present, and the COUNT rule part is also not present, the "[RecurrenceRule](#recurrencerule-property-caldav-component)" is considered to repeat forever. |
| COUNT | The COUNT rule part defines the number of occurrences at which to range-bound the recurrence. The StartDate property value always counts as the first occurrence. |
| INTERVAL | Positive integer representing at which intervals the recurrence rule repeats. The default value is "1", meaning every second for a SECONDLY rule, every minute for a MINUTELY rule, every hour for an HOURLY rule, etc. For example, within a DAILY rule, a value of "8" means every eight days. |
| BYSECOND | The BYSECOND rule part specifies a COMMA-separated list of seconds within a minute. Valid values are 0 to 60. |
| BYMINUTE | The BYMINUTE rule part specifies a COMMA-separated list of minutes within an hour. Valid values are 0 to 59. |
| BYHOUR | The BYHOUR rule part specifies a COMMA-separated list of hours of the day. Valid values are 0 to 23. |
| BYDAY | The BYDAY rule part specifies a COMMA-separated list of days of the week; SU indicates Sunday; MO indicates Monday; TU indicates Tuesday; WE indicates Wednesday; TH indicates Thursday; FR indicates Friday; and SA indicates Saturday. Each BYDAY value can also be preceded by a positive (+n) or negative (-n) integer. If present, this indicates the nth occurrence of a specific day within the MONTHLY or YEARLY [RecurrenceRule](#recurrencerule-property-caldav-component). |
| BYMONTHDAY | The BYMONTHDAY rule part specifies a COMMA-separated list of days of the month. Valid values are 1 to 31 or -31 to -1. For example, -10 represents the tenth to the last day of the month. The BYMONTHDAY rule part MUST NOT be specified when the FREQ rule part is set to WEEKLY. |
| BYYEARDAY | The BYYEARDAY rule part specifies a COMMA-separated list of days of the year. Valid values are 1 to 366 or -366 to -1. For example, -1 represents the last day of the year (December 31st) and -306 represents the 306th to the last day of the year (March 1st). The BYYEARDAY rule part MUST NOT be specified when the FREQ rule part is set to DAILY, WEEKLY, or MONTHLY. |
| BYWEEKNO | The BYWEEKNO rule part specifies a COMMA-separated list of ordinals specifying weeks of the year. Valid values are 1 to 53 or -53 to -1. This corresponds to weeks according to week numbering as defined in ISO.8601.2004. A week is defined as a seven day period, starting on the day of the week defined to be the week start (see WKST). Week number one of the calendar year is the first week that contains at least four (4) days in that calendar year. This rule part MUST NOT be used when the FREQ rule part is set to anything other than YEARLY. For example, 3 represents the third week of the year. |
| BYMONTH | The BYMONTH rule part specifies a COMMA-separated list of months of the year. Valid values are 1 to 12. |
| WKST | Specifies the day on which the workweek starts. Valid values are MO, TU, WE, TH, FR, SA, and SU. This is significant when a WEEKLY [RecurrenceRule](#recurrencerule-property-caldav-component) has an interval greater than 1, and a BYDAY rule part is specified. This is also significant when in a YEARLY [RecurrenceRule](#recurrencerule-property-caldav-component) when a BYWEEKNO rule part is specified. The default value is MO. |
| BYSETPOS | The BYSETPOS rule part specifies a COMMA-separated list of values that corresponds to the nth occurrence within the set of recurrence instances specified by the rule. BYSETPOS operates on a set of recurrence instances in one interval of the recurrence rule. For example, in a WEEKLY rule, the interval would be one week A set of recurrence instances starts at the beginning of the interval defined by the FREQ rule part. Valid values are 1 to 366 or -366 to -1. It MUST only be used in conjunction with another BYxxx rule part. For example "the last work day of the month" could be represented as: FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1. Each BYSETPOS value can include a positive (+n) or negative (-n) integer. If present, this indicates the nth occurrence of the specific occurrence within the set of occurrences specified by the rule. |

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

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

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

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

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the [CalDAV](#caldav-component) **EventDetails** event.

## Data Type

**string**

# RecurrenceId Property ([CalDAV](#caldav-component) Component)

Identifies a recurring event.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) RecurrenceId() (string, error)func (obj *CalDAV) SetRecurrenceId(value string) error
```

## Default Value

""

## Remarks

Identifies a recurring event.

This property is used in conjunction with the [CalDAV](#caldav-component) **UID** and **Sequence** properties to identify a specific instance of a recurring event, todo, or journal. The value of this property is the value of the [CalDAV](#caldav-component) **StartDate** property of the original recurrence instance.

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the [CalDAV](#caldav-component) **EventDetails** event.

## Data Type

**string**

# RecurrenceRule Property ([CalDAV](#caldav-component) Component)

This property defines the recurrence rule for the event.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) RecurrenceRule() (string, error)func (obj *CalDAV) SetRecurrenceRule(value string) error
```

## Default Value

""

## Remarks

This property defines the recurrence rule for the event.

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

The table below shows the supported rules and their usage.

|  |  |
| --- | --- |
| FREQ | The FREQ rule part identifies the type of recurrence rule. This rule part MUST be specified in the recurrence rule. Valid values include SECONDLY, to specify repeating events based on an interval of a second or more; MINUTELY, to specify repeating events based on an interval of a minute or more; HOURLY, to specify repeating events based on an interval of an hour or more; DAILY, to specify repeating events based on an interval of a day or more; WEEKLY, to specify repeating events based on an interval of a week or more; MONTHLY, to specify repeating events based on an interval of a month or more; and YEARLY, to specify repeating events based on an interval of a year or more. |
| UNTIL | The UNTIL rule part defines a DATE (YYYYMMDD) or DATE-TIME (YYYYMMDDThhmmss) value that bounds the recurrence rule in an inclusive manner. If the value specified by UNTIL is synchronized with the specified recurrence, this DATE or DATE-TIME becomes the last instance of the recurrence. The value of the UNTIL rule part MUST have the same value type as the StartDate property. Furthermore, if the StartDate is specified as a date with local time, then the UNTIL rule part MUST also be specified as a date with local time. If the StartDate property is specified as a date with UTC time or a date with local time and time zone reference, then the UNTIL rule part MUST be specified as a date with UTC time. If not present, and the COUNT rule part is also not present, the "[RecurrenceRule](#recurrencerule-property-caldav-component)" is considered to repeat forever. |
| COUNT | The COUNT rule part defines the number of occurrences at which to range-bound the recurrence. The StartDate property value always counts as the first occurrence. |
| INTERVAL | Positive integer representing at which intervals the recurrence rule repeats. The default value is "1", meaning every second for a SECONDLY rule, every minute for a MINUTELY rule, every hour for an HOURLY rule, etc. For example, within a DAILY rule, a value of "8" means every eight days. |
| BYSECOND | The BYSECOND rule part specifies a COMMA-separated list of seconds within a minute. Valid values are 0 to 60. |
| BYMINUTE | The BYMINUTE rule part specifies a COMMA-separated list of minutes within an hour. Valid values are 0 to 59. |
| BYHOUR | The BYHOUR rule part specifies a COMMA-separated list of hours of the day. Valid values are 0 to 23. |
| BYDAY | The BYDAY rule part specifies a COMMA-separated list of days of the week; SU indicates Sunday; MO indicates Monday; TU indicates Tuesday; WE indicates Wednesday; TH indicates Thursday; FR indicates Friday; and SA indicates Saturday. Each BYDAY value can also be preceded by a positive (+n) or negative (-n) integer. If present, this indicates the nth occurrence of a specific day within the MONTHLY or YEARLY [RecurrenceRule](#recurrencerule-property-caldav-component). |
| BYMONTHDAY | The BYMONTHDAY rule part specifies a COMMA-separated list of days of the month. Valid values are 1 to 31 or -31 to -1. For example, -10 represents the tenth to the last day of the month. The BYMONTHDAY rule part MUST NOT be specified when the FREQ rule part is set to WEEKLY. |
| BYYEARDAY | The BYYEARDAY rule part specifies a COMMA-separated list of days of the year. Valid values are 1 to 366 or -366 to -1. For example, -1 represents the last day of the year (December 31st) and -306 represents the 306th to the last day of the year (March 1st). The BYYEARDAY rule part MUST NOT be specified when the FREQ rule part is set to DAILY, WEEKLY, or MONTHLY. |
| BYWEEKNO | The BYWEEKNO rule part specifies a COMMA-separated list of ordinals specifying weeks of the year. Valid values are 1 to 53 or -53 to -1. This corresponds to weeks according to week numbering as defined in ISO.8601.2004. A week is defined as a seven day period, starting on the day of the week defined to be the week start (see WKST). Week number one of the calendar year is the first week that contains at least four (4) days in that calendar year. This rule part MUST NOT be used when the FREQ rule part is set to anything other than YEARLY. For example, 3 represents the third week of the year. |
| BYMONTH | The BYMONTH rule part specifies a COMMA-separated list of months of the year. Valid values are 1 to 12. |
| WKST | Specifies the day on which the workweek starts. Valid values are MO, TU, WE, TH, FR, SA, and SU. This is significant when a WEEKLY [RecurrenceRule](#recurrencerule-property-caldav-component) has an interval greater than 1, and a BYDAY rule part is specified. This is also significant when in a YEARLY [RecurrenceRule](#recurrencerule-property-caldav-component) when a BYWEEKNO rule part is specified. The default value is MO. |
| BYSETPOS | The BYSETPOS rule part specifies a COMMA-separated list of values that corresponds to the nth occurrence within the set of recurrence instances specified by the rule. BYSETPOS operates on a set of recurrence instances in one interval of the recurrence rule. For example, in a WEEKLY rule, the interval would be one week A set of recurrence instances starts at the beginning of the interval defined by the FREQ rule part. Valid values are 1 to 366 or -366 to -1. It MUST only be used in conjunction with another BYxxx rule part. For example "the last work day of the month" could be represented as: FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1. Each BYSETPOS value can include a positive (+n) or negative (-n) integer. If present, this indicates the nth occurrence of the specific occurrence within the set of occurrences specified by the rule. |

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

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

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

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

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the [CalDAV](#caldav-component) **EventDetails** event.

## Data Type

**string**

# RelatedTo Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) RelatedTo() (string, error)func (obj *CalDAV) SetRelatedTo(value string) error
```

## Default Value

""

## Remarks

This property is specified within the *vEvent*, *vTodo*, and *vJournal* calendar [EventType](#eventtype-property-caldav-component)s to represent a relationship or reference between this calendar component and another. This value would be represented by the [UID](#uid-property-caldav-component) property of the event, which this event is related to. The RelatedTo value points to another calendar component that has a PARENT relationship to the referencing object.

## Data Type

**string**

# ReportFilterAlarmEnd Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ReportFilterAlarmEnd() (string, error)func (obj *CalDAV) SetReportFilterAlarmEnd(value string) error
```

## Default Value

""

## Remarks

Limits the events returned in the report to only those with an alarm set in the range specified by [ReportFilterAlarmStart](#reportfilteralarmstart-property-caldav-component) and [ReportFilterAlarmEnd](#reportfilteralarmend-property-caldav-component). The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

## Data Type

**string**

# ReportFilterAlarmStart Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ReportFilterAlarmStart() (string, error)func (obj *CalDAV) SetReportFilterAlarmStart(value string) error
```

## Default Value

""

## Remarks

Limits the events returned in the report to only those with an alarm set in the range specified by [ReportFilterAlarmStart](#reportfilteralarmstart-property-caldav-component) and [ReportFilterAlarmEnd](#reportfilteralarmend-property-caldav-component). The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

## Data Type

**string**

# ReportFilterCustomFilter Property ([CalDAV](#caldav-component) Component)

Allows the user to specify his own filter XML.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ReportFilterCustomFilter() (string, error)func (obj *CalDAV) SetReportFilterCustomFilter(value string) error
```

## Default Value

""

## Remarks

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

## Data Type

**string**

# ReportFilterEndDate Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ReportFilterEndDate() (string, error)func (obj *CalDAV) SetReportFilterEndDate(value string) error
```

## Default Value

""

## Remarks

Limits the events returned in the report to only those which occur in the time range specified by [ReportFilterStartDate](#reportfilterstartdate-property-caldav-component) and [ReportFilterEndDate](#reportfilterenddate-property-caldav-component). The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

## Data Type

**string**

# ReportFilterEventType Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ReportFilterEventType() (int32, error)func (obj *CalDAV) SetReportFilterEventType(value int32) error
```

## Possible Values

```text
0   // Event1   // Todo2   // Journal3   // FreeBusy4   // All
```

## Default Value

0

## Remarks

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

## Data Type

**int32**

# ReportFilterProperty Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ReportFilterProperty() (string, error)func (obj *CalDAV) SetReportFilterProperty(value string) error
```

## Default Value

""

## Remarks

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

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

For more advanced filtering, you may specify your own [ReportFilterCustomFilter](#reportfiltercustomfilter-property-caldav-component).

## Data Type

**string**

# ReportFilterRecurEnd Property ([CalDAV](#caldav-component) Component)

Limits the recurring events returned in the report.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ReportFilterRecurEnd() (string, error)func (obj *CalDAV) SetReportFilterRecurEnd(value string) error
```

## Default Value

""

## Remarks

Limits the recurring events returned in the report.

Use of the CalDAV limit-recurrence-set element causes the server to only return overridden recurrence components that overlap the time range specified by [ReportFilterRecurStart](#reportfilterrecurstart-property-caldav-component) and [ReportFilterRecurEnd](#reportfilterrecurend-property-caldav-component) or that affect other instances that overlap the time range specified by [ReportFilterStartDate](#reportfilterstartdate-property-caldav-component) and [ReportFilterEndDate](#reportfilterenddate-property-caldav-component). The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

Note that the [ReportFilterRecurEnd](#reportfilterrecurend-property-caldav-component) property cannot be used when [ReportFilterReturnCalendarData](#reportfilterreturncalendardata-property-caldav-component) is False.

## Data Type

**string**

# ReportFilterRecurStart Property ([CalDAV](#caldav-component) Component)

Limits the recurring events returned in the report.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ReportFilterRecurStart() (string, error)func (obj *CalDAV) SetReportFilterRecurStart(value string) error
```

## Default Value

""

## Remarks

Limits the recurring events returned in the report.

Use of the CalDAV limit-recurrence-set element causes the server to only return overridden recurrence components that overlap the time range specified by [ReportFilterRecurStart](#reportfilterrecurstart-property-caldav-component) and [ReportFilterRecurEnd](#reportfilterrecurend-property-caldav-component) or that affect other instances that overlap the time range specified by [ReportFilterStartDate](#reportfilterstartdate-property-caldav-component) and [ReportFilterEndDate](#reportfilterenddate-property-caldav-component). The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

Note that the [ReportFilterRecurStart](#reportfilterrecurstart-property-caldav-component) property cannot be used when [ReportFilterReturnCalendarData](#reportfilterreturncalendardata-property-caldav-component) is False.

## Data Type

**string**

# ReportFilterReturnCalendarData Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ReportFilterReturnCalendarData() (bool, error)func (obj *CalDAV) SetReportFilterReturnCalendarData(value bool) error
```

## Default Value

true

## Remarks

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

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

Note that this filter is not compatible with the [ReportFilterRecurStart](#reportfilterrecurstart-property-caldav-component) and [ReportFilterRecurEnd](#reportfilterrecurend-property-caldav-component) properties.

## Data Type

**bool**

# ReportFilterStartDate Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ReportFilterStartDate() (string, error)func (obj *CalDAV) SetReportFilterStartDate(value string) error
```

## Default Value

""

## Remarks

Limits the events returned in the report to only those which occur in the time range specified by [ReportFilterStartDate](#reportfilterstartdate-property-caldav-component) and [ReportFilterEndDate](#reportfilterenddate-property-caldav-component). The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

## Data Type

**string**

# ReportFilterUID Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ReportFilterUID() (string, error)func (obj *CalDAV) SetReportFilterUID(value string) error
```

## Default Value

""

## Remarks

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

## Data Type

**string**

# Sequence Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Sequence() (int32, error)func (obj *CalDAV) SetSequence(value int32) error
```

## 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](#organizer-property-caldav-component)'s Calendar User Agent (CUA) each time the [Organizer](#organizer-property-caldav-component) makes a significant revision to the calendar event. Therefore, a Sequence number of 2 means the event has been revised twice.

The [Organizer](#organizer-property-caldav-component) includes this property in a calendar event that it sends to an [Attendees](#attendees-property-caldav-component) to specify the current version of the event. Likewise, the [Attendees](#attendees-property-caldav-component) includes this property in an event that it sends to the [Organizer](#organizer-property-caldav-component) to specify the version of the calendar component to which the [Attendees](#attendees-property-caldav-component) is referring.

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

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**int32**

# SSLAcceptServerCertEffectiveDate Property ([CalDAV](#caldav-component) Component)

The date on which this certificate becomes valid.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertEffectiveDate() (string, error)
```

## Default Value

""

## Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertExpirationDate Property ([CalDAV](#caldav-component) Component)

The date on which the certificate expires.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertExpirationDate() (string, error)
```

## Default Value

""

## Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertExtendedKeyUsage Property ([CalDAV](#caldav-component) Component)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertExtendedKeyUsage() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertFingerprint Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertFingerprint() (string, error)
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertFingerprintSHA1 Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertFingerprintSHA1() (string, error)
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertFingerprintSHA256 Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertFingerprintSHA256() (string, error)
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertIssuer Property ([CalDAV](#caldav-component) Component)

The issuer of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertIssuer() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertPrivateKey Property ([CalDAV](#caldav-component) Component)

The private key of the certificate (if available).

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertPrivateKey() (string, error)
```

## Default Value

""

## Remarks

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

NOTE: The [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-caldav-component) may be available but not exportable. In this case, [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-caldav-component) returns an empty string.

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertPrivateKeyAvailable Property ([CalDAV](#caldav-component) Component)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertPrivateKeyAvailable() (bool, error)
```

## Default Value

false

## Remarks

Whether a [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-caldav-component) is available for the selected certificate. If [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-caldav-component) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

**bool**

# SSLAcceptServerCertPrivateKeyContainer Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertPrivateKeyContainer() (string, error)
```

## Default Value

""

## Remarks

The name of the [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-caldav-component) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertPublicKey Property ([CalDAV](#caldav-component) Component)

The public key of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertPublicKey() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertPublicKeyAlgorithm Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertPublicKeyAlgorithm() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertPublicKeyLength Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertPublicKeyLength() (int32, error)
```

## Default Value

0

## Remarks

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

This property is read-only.

## Data Type

**int32**

# SSLAcceptServerCertSerialNumber Property ([CalDAV](#caldav-component) Component)

The serial number of the certificate encoded as a string.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertSerialNumber() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertSignatureAlgorithm Property ([CalDAV](#caldav-component) Component)

The text description of the certificate's signature algorithm.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertSignatureAlgorithm() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertStore Property ([CalDAV](#caldav-component) Component)

The name of the certificate store for the client certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertStore() ([]byte, error)func (obj *CalDAV) SetSSLAcceptServerCertStore(value []byte) error
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-caldav-component) property denotes the type of the certificate store specified by [SSLAcceptServerCertStore](#sslacceptservercertstore-property-caldav-component). If the store is password-protected, specify the password in [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-caldav-component).

[SSLAcceptServerCertStore](#sslacceptservercertstore-property-caldav-component) is used in conjunction with the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-caldav-component) property to specify client certificates. If [SSLAcceptServerCertStore](#sslacceptservercertstore-property-caldav-component) has a value, and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-caldav-component) or [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-caldav-component) is set, a search for a certificate is initiated. Please see the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-caldav-component) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

## Data Type

**[]byte**

# SSLAcceptServerCertStorePassword Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertStorePassword() (string, error)func (obj *CalDAV) SetSSLAcceptServerCertStorePassword(value string) error
```

## Default Value

""

## Remarks

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

## Data Type

**string**

# SSLAcceptServerCertStoreType Property ([CalDAV](#caldav-component) Component)

The type of certificate store for this certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertStoreType() (int32, error)func (obj *CalDAV) SetSSLAcceptServerCertStoreType(value int32) error
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-caldav-component), the full path of the PKCS#11 DLL as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-caldav-component), and the PIN as the [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-caldav-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-caldav-component) and set [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-caldav-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

## Data Type

**int32**

# SSLAcceptServerCertSubjectAltNames Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertSubjectAltNames() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertThumbprintMD5 Property ([CalDAV](#caldav-component) Component)

The MD5 hash of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertThumbprintMD5() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertThumbprintSHA1 Property ([CalDAV](#caldav-component) Component)

The SHA-1 hash of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertThumbprintSHA1() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertThumbprintSHA256 Property ([CalDAV](#caldav-component) Component)

The SHA-256 hash of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertThumbprintSHA256() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertUsage Property ([CalDAV](#caldav-component) Component)

The text description of UsageFlags .

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertUsage() (string, error)
```

## Default Value

""

## Remarks

The text description of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-caldav-component).

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

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

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertUsageFlags Property ([CalDAV](#caldav-component) Component)

The flags that show intended use for the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertUsageFlags() (int32, error)
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-caldav-component) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-caldav-component) property for a text representation of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-caldav-component).

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

This property is read-only.

## Data Type

**int32**

# SSLAcceptServerCertVersion Property ([CalDAV](#caldav-component) Component)

The certificate's version number.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertVersion() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLAcceptServerCertSubject Property ([CalDAV](#caldav-component) Component)

The subject of the certificate used for client authentication.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertSubject() (string, error)func (obj *CalDAV) SetSSLAcceptServerCertSubject(value string) error
```

## Default Value

""

## Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

## Data Type

**string**

# SSLAcceptServerCertEncoded Property ([CalDAV](#caldav-component) Component)

The certificate (PEM/Base64 encoded).

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLAcceptServerCertEncoded() ([]byte, error)func (obj *CalDAV) SetSSLAcceptServerCertEncoded(value []byte) error
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLAcceptServerCertStore](#sslacceptservercertstore-property-caldav-component) and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-caldav-component) properties also may be used to specify a certificate.

When [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-caldav-component) is set, a search is initiated in the current [SSLAcceptServerCertStore](#sslacceptservercertstore-property-caldav-component) for the private key of the certificate. If the key is found, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-caldav-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-caldav-component) is set to an empty string.

## Data Type

**[]byte**

# SSLCertEffectiveDate Property ([CalDAV](#caldav-component) Component)

The date on which this certificate becomes valid.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertEffectiveDate() (string, error)
```

## Default Value

""

## Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

## Data Type

**string**

# SSLCertExpirationDate Property ([CalDAV](#caldav-component) Component)

The date on which the certificate expires.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertExpirationDate() (string, error)
```

## Default Value

""

## Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

## Data Type

**string**

# SSLCertExtendedKeyUsage Property ([CalDAV](#caldav-component) Component)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertExtendedKeyUsage() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLCertFingerprint Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertFingerprint() (string, error)
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

**string**

# SSLCertFingerprintSHA1 Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertFingerprintSHA1() (string, error)
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

**string**

# SSLCertFingerprintSHA256 Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertFingerprintSHA256() (string, error)
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

**string**

# SSLCertIssuer Property ([CalDAV](#caldav-component) Component)

The issuer of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertIssuer() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLCertPrivateKey Property ([CalDAV](#caldav-component) Component)

The private key of the certificate (if available).

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertPrivateKey() (string, error)
```

## Default Value

""

## Remarks

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

NOTE: The [SSLCertPrivateKey](#sslcertprivatekey-property-caldav-component) may be available but not exportable. In this case, [SSLCertPrivateKey](#sslcertprivatekey-property-caldav-component) returns an empty string.

This property is read-only.

## Data Type

**string**

# SSLCertPrivateKeyAvailable Property ([CalDAV](#caldav-component) Component)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertPrivateKeyAvailable() (bool, error)
```

## Default Value

false

## Remarks

Whether a [SSLCertPrivateKey](#sslcertprivatekey-property-caldav-component) is available for the selected certificate. If [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-caldav-component) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

**bool**

# SSLCertPrivateKeyContainer Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertPrivateKeyContainer() (string, error)
```

## Default Value

""

## Remarks

The name of the [SSLCertPrivateKey](#sslcertprivatekey-property-caldav-component) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

**string**

# SSLCertPublicKey Property ([CalDAV](#caldav-component) Component)

The public key of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertPublicKey() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLCertPublicKeyAlgorithm Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertPublicKeyAlgorithm() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLCertPublicKeyLength Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertPublicKeyLength() (int32, error)
```

## Default Value

0

## Remarks

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

This property is read-only.

## Data Type

**int32**

# SSLCertSerialNumber Property ([CalDAV](#caldav-component) Component)

The serial number of the certificate encoded as a string.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertSerialNumber() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLCertSignatureAlgorithm Property ([CalDAV](#caldav-component) Component)

The text description of the certificate's signature algorithm.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertSignatureAlgorithm() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLCertStore Property ([CalDAV](#caldav-component) Component)

The name of the certificate store for the client certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertStore() ([]byte, error)func (obj *CalDAV) SetSSLCertStore(value []byte) error
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [SSLCertStoreType](#sslcertstoretype-property-caldav-component) property denotes the type of the certificate store specified by [SSLCertStore](#sslcertstore-property-caldav-component). If the store is password-protected, specify the password in [SSLCertStorePassword](#sslcertstorepassword-property-caldav-component).

[SSLCertStore](#sslcertstore-property-caldav-component) is used in conjunction with the [SSLCertSubject](#sslcertsubject-property-caldav-component) property to specify client certificates. If [SSLCertStore](#sslcertstore-property-caldav-component) has a value, and [SSLCertSubject](#sslcertsubject-property-caldav-component) or [SSLCertEncoded](#sslcertencoded-property-caldav-component) is set, a search for a certificate is initiated. Please see the [SSLCertSubject](#sslcertsubject-property-caldav-component) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

## Data Type

**[]byte**

# SSLCertStorePassword Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertStorePassword() (string, error)func (obj *CalDAV) SetSSLCertStorePassword(value string) error
```

## Default Value

""

## Remarks

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

## Data Type

**string**

# SSLCertStoreType Property ([CalDAV](#caldav-component) Component)

The type of certificate store for this certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertStoreType() (int32, error)func (obj *CalDAV) SetSSLCertStoreType(value int32) error
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLCertStoreType](#sslcertstoretype-property-caldav-component), the full path of the PKCS#11 DLL as the [SSLCertStore](#sslcertstore-property-caldav-component), and the PIN as the [SSLCertStorePassword](#sslcertstorepassword-property-caldav-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLCertStore](#sslcertstore-property-caldav-component) and set [SSLCertStorePassword](#sslcertstorepassword-property-caldav-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

## Data Type

**int32**

# SSLCertSubjectAltNames Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertSubjectAltNames() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLCertThumbprintMD5 Property ([CalDAV](#caldav-component) Component)

The MD5 hash of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertThumbprintMD5() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLCertThumbprintSHA1 Property ([CalDAV](#caldav-component) Component)

The SHA-1 hash of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertThumbprintSHA1() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLCertThumbprintSHA256 Property ([CalDAV](#caldav-component) Component)

The SHA-256 hash of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertThumbprintSHA256() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLCertUsage Property ([CalDAV](#caldav-component) Component)

The text description of UsageFlags .

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertUsage() (string, error)
```

## Default Value

""

## Remarks

The text description of [SSLCertUsageFlags](#sslcertusageflags-property-caldav-component).

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

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

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

This property is read-only.

## Data Type

**string**

# SSLCertUsageFlags Property ([CalDAV](#caldav-component) Component)

The flags that show intended use for the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertUsageFlags() (int32, error)
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SSLCertUsageFlags](#sslcertusageflags-property-caldav-component) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [SSLCertUsage](#sslcertusage-property-caldav-component) property for a text representation of [SSLCertUsageFlags](#sslcertusageflags-property-caldav-component).

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

This property is read-only.

## Data Type

**int32**

# SSLCertVersion Property ([CalDAV](#caldav-component) Component)

The certificate's version number.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertVersion() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLCertSubject Property ([CalDAV](#caldav-component) Component)

The subject of the certificate used for client authentication.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertSubject() (string, error)func (obj *CalDAV) SetSSLCertSubject(value string) error
```

## Default Value

""

## Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

## Data Type

**string**

# SSLCertEncoded Property ([CalDAV](#caldav-component) Component)

The certificate (PEM/Base64 encoded).

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLCertEncoded() ([]byte, error)func (obj *CalDAV) SetSSLCertEncoded(value []byte) error
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLCertStore](#sslcertstore-property-caldav-component) and [SSLCertSubject](#sslcertsubject-property-caldav-component) properties also may be used to specify a certificate.

When [SSLCertEncoded](#sslcertencoded-property-caldav-component) is set, a search is initiated in the current [SSLCertStore](#sslcertstore-property-caldav-component) for the private key of the certificate. If the key is found, [SSLCertSubject](#sslcertsubject-property-caldav-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLCertSubject](#sslcertsubject-property-caldav-component) is set to an empty string.

## Data Type

**[]byte**

# SSLProvider Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLProvider() (int32, error)func (obj *CalDAV) SetSSLProvider(value int32) error
```

## Possible Values

```text
0   // Automatic1   // Platform2   // Internal
```

## 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 struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

|  |  |
| --- | --- |
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |

 **Additional Notes**

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

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

## Data Type

**int32**

# SSLServerCertEffectiveDate Property ([CalDAV](#caldav-component) Component)

The date on which this certificate becomes valid.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertEffectiveDate() (string, error)
```

## Default Value

""

## Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

## Data Type

**string**

# SSLServerCertExpirationDate Property ([CalDAV](#caldav-component) Component)

The date on which the certificate expires.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertExpirationDate() (string, error)
```

## Default Value

""

## Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

## Data Type

**string**

# SSLServerCertExtendedKeyUsage Property ([CalDAV](#caldav-component) Component)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertExtendedKeyUsage() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLServerCertFingerprint Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertFingerprint() (string, error)
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

**string**

# SSLServerCertFingerprintSHA1 Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertFingerprintSHA1() (string, error)
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

**string**

# SSLServerCertFingerprintSHA256 Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertFingerprintSHA256() (string, error)
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

**string**

# SSLServerCertIssuer Property ([CalDAV](#caldav-component) Component)

The issuer of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertIssuer() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLServerCertPrivateKey Property ([CalDAV](#caldav-component) Component)

The private key of the certificate (if available).

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertPrivateKey() (string, error)
```

## Default Value

""

## Remarks

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

NOTE: The [SSLServerCertPrivateKey](#sslservercertprivatekey-property-caldav-component) may be available but not exportable. In this case, [SSLServerCertPrivateKey](#sslservercertprivatekey-property-caldav-component) returns an empty string.

This property is read-only.

## Data Type

**string**

# SSLServerCertPrivateKeyAvailable Property ([CalDAV](#caldav-component) Component)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertPrivateKeyAvailable() (bool, error)
```

## Default Value

false

## Remarks

Whether a [SSLServerCertPrivateKey](#sslservercertprivatekey-property-caldav-component) is available for the selected certificate. If [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-caldav-component) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

**bool**

# SSLServerCertPrivateKeyContainer Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertPrivateKeyContainer() (string, error)
```

## Default Value

""

## Remarks

The name of the [SSLServerCertPrivateKey](#sslservercertprivatekey-property-caldav-component) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

**string**

# SSLServerCertPublicKey Property ([CalDAV](#caldav-component) Component)

The public key of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertPublicKey() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLServerCertPublicKeyAlgorithm Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertPublicKeyAlgorithm() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLServerCertPublicKeyLength Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertPublicKeyLength() (int32, error)
```

## Default Value

0

## Remarks

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

This property is read-only.

## Data Type

**int32**

# SSLServerCertSerialNumber Property ([CalDAV](#caldav-component) Component)

The serial number of the certificate encoded as a string.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertSerialNumber() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLServerCertSignatureAlgorithm Property ([CalDAV](#caldav-component) Component)

The text description of the certificate's signature algorithm.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertSignatureAlgorithm() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLServerCertStore Property ([CalDAV](#caldav-component) Component)

The name of the certificate store for the client certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertStore() ([]byte, error)
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [SSLServerCertStoreType](#sslservercertstoretype-property-caldav-component) property denotes the type of the certificate store specified by [SSLServerCertStore](#sslservercertstore-property-caldav-component). If the store is password-protected, specify the password in [SSLServerCertStorePassword](#sslservercertstorepassword-property-caldav-component).

[SSLServerCertStore](#sslservercertstore-property-caldav-component) is used in conjunction with the [SSLServerCertSubject](#sslservercertsubject-property-caldav-component) property to specify client certificates. If [SSLServerCertStore](#sslservercertstore-property-caldav-component) has a value, and [SSLServerCertSubject](#sslservercertsubject-property-caldav-component) or [SSLServerCertEncoded](#sslservercertencoded-property-caldav-component) is set, a search for a certificate is initiated. Please see the [SSLServerCertSubject](#sslservercertsubject-property-caldav-component) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

This property is read-only.

## Data Type

**[]byte**

# SSLServerCertStorePassword Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertStorePassword() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLServerCertStoreType Property ([CalDAV](#caldav-component) Component)

The type of certificate store for this certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertStoreType() (int32, error)
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLServerCertStoreType](#sslservercertstoretype-property-caldav-component), the full path of the PKCS#11 DLL as the [SSLServerCertStore](#sslservercertstore-property-caldav-component), and the PIN as the [SSLServerCertStorePassword](#sslservercertstorepassword-property-caldav-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLServerCertStore](#sslservercertstore-property-caldav-component) and set [SSLServerCertStorePassword](#sslservercertstorepassword-property-caldav-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

This property is read-only.

## Data Type

**int32**

# SSLServerCertSubjectAltNames Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertSubjectAltNames() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLServerCertThumbprintMD5 Property ([CalDAV](#caldav-component) Component)

The MD5 hash of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertThumbprintMD5() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLServerCertThumbprintSHA1 Property ([CalDAV](#caldav-component) Component)

The SHA-1 hash of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertThumbprintSHA1() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLServerCertThumbprintSHA256 Property ([CalDAV](#caldav-component) Component)

The SHA-256 hash of the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertThumbprintSHA256() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLServerCertUsage Property ([CalDAV](#caldav-component) Component)

The text description of UsageFlags .

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertUsage() (string, error)
```

## Default Value

""

## Remarks

The text description of [SSLServerCertUsageFlags](#sslservercertusageflags-property-caldav-component).

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

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

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

This property is read-only.

## Data Type

**string**

# SSLServerCertUsageFlags Property ([CalDAV](#caldav-component) Component)

The flags that show intended use for the certificate.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertUsageFlags() (int32, error)
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SSLServerCertUsageFlags](#sslservercertusageflags-property-caldav-component) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [SSLServerCertUsage](#sslservercertusage-property-caldav-component) property for a text representation of [SSLServerCertUsageFlags](#sslservercertusageflags-property-caldav-component).

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

This property is read-only.

## Data Type

**int32**

# SSLServerCertVersion Property ([CalDAV](#caldav-component) Component)

The certificate's version number.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertVersion() (string, error)
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

**string**

# SSLServerCertSubject Property ([CalDAV](#caldav-component) Component)

The subject of the certificate used for client authentication.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertSubject() (string, error)
```

## Default Value

""

## Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

This property is read-only.

## Data Type

**string**

# SSLServerCertEncoded Property ([CalDAV](#caldav-component) Component)

The certificate (PEM/Base64 encoded).

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SSLServerCertEncoded() ([]byte, error)
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLServerCertStore](#sslservercertstore-property-caldav-component) and [SSLServerCertSubject](#sslservercertsubject-property-caldav-component) properties also may be used to specify a certificate.

When [SSLServerCertEncoded](#sslservercertencoded-property-caldav-component) is set, a search is initiated in the current [SSLServerCertStore](#sslservercertstore-property-caldav-component) for the private key of the certificate. If the key is found, [SSLServerCertSubject](#sslservercertsubject-property-caldav-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLServerCertSubject](#sslservercertsubject-property-caldav-component) is set to an empty string.

This property is read-only.

## Data Type

**[]byte**

# StartDate Property ([CalDAV](#caldav-component) Component)

Specifies the date and time that an event begins.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) StartDate() (string, error)func (obj *CalDAV) SetStartDate(value string) error
```

## Default Value

""

## Remarks

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

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# Status Property ([CalDAV](#caldav-component) Component)

Defines the overall status or confirmation for the calendar event.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Status() (string, error)func (obj *CalDAV) SetStatus(value string) error
```

## Default Value

""

## Remarks

In a group-scheduled calendar component, the property is used by the [Organizer](#organizer-property-caldav-component) to provide a confirmation of the event to the [Attendees](#attendees-property-caldav-component). For example in a *vEvent* [EventType](#eventtype-property-caldav-component) the [Organizer](#organizer-property-caldav-component) can indicate that a meeting is tentative, confirmed, or canceled. For a *vTodo* [EventType](#eventtype-property-caldav-component), the [Organizer](#organizer-property-caldav-component) 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](#eventtype-property-caldav-component), the [Organizer](#organizer-property-caldav-component) can indicate that a journal entry is draft, final, or has been canceled or removed.

Statuses for a *vEvent* [EventType](#eventtype-property-caldav-component):

|  |  |
| --- | --- |
| TENTATIVE | Indicates event is tentative. |
| CONFIRMED | Indicates event is definite. |
| CANCELLED | Indicates event was canceled. |

 Statuses for a *vTodo* [EventType](#eventtype-property-caldav-component):

|  |  |
| --- | --- |
| NEEDS-ACTION | Indicates to-do needs action. |
| COMPLETED | Indicates to-do completed. |
| IN-PROCESS | Indicates to-do in process of. |
| CANCELLED | Indicates to-do was canceled. |

 Statuses for a *vJournal* [EventType](#eventtype-property-caldav-component):

|  |  |
| --- | --- |
| DRAFT | Indicates event is draft. |
| FINAL | Indicates event is final. |
| CANCELLED | Indicates event is removed. |

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# Summary Property ([CalDAV](#caldav-component) Component)

Defines a short summary or subject for the calendar event.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Summary() (string, error)func (obj *CalDAV) SetSummary(value string) error
```

## Default Value

""

## Remarks

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

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# Timeout Property ([CalDAV](#caldav-component) Component)

The timeout for the class.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Timeout() (int32, error)func (obj *CalDAV) SetTimeout(value int32) error
```

## 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 struct will wait for the operation to complete before returning control.

The struct will use [DoEvents](#doevents-method-caldav-component) 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 struct fails with an error.

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

The default value for the Timeout property is 60 seconds.

## Data Type

**int32**

# Timestamp Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Timestamp() (string, error)func (obj *CalDAV) SetTimestamp(value string) error
```

## Default Value

""

## Remarks

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

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

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# TimezoneDSTName Property ([CalDAV](#caldav-component) Component)

The customary name for the daylight-savings time zone.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) TimezoneDSTName() (string, error)func (obj *CalDAV) SetTimezoneDSTName(value string) error
```

## Default Value

""

## Remarks

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

The following example shows the [CalTimezone](#Type_CalTimezone) set to Eastern time.

```text
  CalDAV.Timezone.TimezoneId      = "US-Eastern";
  CalDAV.Timezone.URL             = "http://zones.example.com/tz/America-New_York.ics"

  CalDAV.Timezone.StdName         = "Eastern Standard Time (US & Canada)";
  CalDAV.Timezone.StdStart        = "20071104T020000";
  CalDAV.Timezone.StdOffsetFrom   = "-400";
  CalDAV.Timezone.StdOffsetTo     = "-500";
  CalDAV.Timezone.StdRule         = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11";

  CalDAV.TimeZone.DSTName         = "Eastern Daylight Time (US & Canada)";
  CalDAV.TimeZone.DSTStart        = "20070311T020000";
  CalDAV.TimeZone.DSTOffsetFrom   = "-500";
  CalDAV.TimeZone.DSTOffsetTo     = "-400";
  CalDAV.TimeZone.DSTRule         = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";
```

## Data Type

**string**

# TimezoneDSTOffsetFrom Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) TimezoneDSTOffsetFrom() (string, error)func (obj *CalDAV) SetTimezoneDSTOffsetFrom(value string) error
```

## Default Value

""

## Remarks

The UTC offset that is in use when the onset of this time zone observance begins. [TimezoneDSTOffsetFrom](#timezonedstoffsetfrom-property-caldav-component) is combined with [TimezoneDSTStart](#timezonedststart-property-caldav-component) to define the effective onset for the daylight-time time zone definition.

[TimezoneDSTStart](#timezonedststart-property-caldav-component), [TimezoneDSTOffsetFrom](#timezonedstoffsetfrom-property-caldav-component), and [TimezoneDSTOffsetTo](#timezonedstoffsetto-property-caldav-component) are all required to specify the daylight-savings time zone.

The following example shows the [CalTimezone](#Type_CalTimezone) set to Eastern time.

```text
  CalDAV.Timezone.TimezoneId      = "US-Eastern";
  CalDAV.Timezone.URL             = "http://zones.example.com/tz/America-New_York.ics"

  CalDAV.Timezone.StdName         = "Eastern Standard Time (US & Canada)";
  CalDAV.Timezone.StdStart        = "20071104T020000";
  CalDAV.Timezone.StdOffsetFrom   = "-400";
  CalDAV.Timezone.StdOffsetTo     = "-500";
  CalDAV.Timezone.StdRule         = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11";

  CalDAV.TimeZone.DSTName         = "Eastern Daylight Time (US & Canada)";
  CalDAV.TimeZone.DSTStart        = "20070311T020000";
  CalDAV.TimeZone.DSTOffsetFrom   = "-500";
  CalDAV.TimeZone.DSTOffsetTo     = "-400";
  CalDAV.TimeZone.DSTRule         = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";
```

## Data Type

**string**

# TimezoneDSTOffsetTo Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) TimezoneDSTOffsetTo() (string, error)func (obj *CalDAV) SetTimezoneDSTOffsetTo(value string) error
```

## Default Value

""

## Remarks

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

[TimezoneDSTStart](#timezonedststart-property-caldav-component), [TimezoneDSTOffsetFrom](#timezonedstoffsetfrom-property-caldav-component), and [TimezoneDSTOffsetTo](#timezonedstoffsetto-property-caldav-component) are all required to specify the daylight-savings time zone.

The following example shows the [CalTimezone](#Type_CalTimezone) set to Eastern time.

```text
  CalDAV.Timezone.TimezoneId      = "US-Eastern";
  CalDAV.Timezone.URL             = "http://zones.example.com/tz/America-New_York.ics"

  CalDAV.Timezone.StdName         = "Eastern Standard Time (US & Canada)";
  CalDAV.Timezone.StdStart        = "20071104T020000";
  CalDAV.Timezone.StdOffsetFrom   = "-400";
  CalDAV.Timezone.StdOffsetTo     = "-500";
  CalDAV.Timezone.StdRule         = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11";

  CalDAV.TimeZone.DSTName         = "Eastern Daylight Time (US & Canada)";
  CalDAV.TimeZone.DSTStart        = "20070311T020000";
  CalDAV.TimeZone.DSTOffsetFrom   = "-500";
  CalDAV.TimeZone.DSTOffsetTo     = "-400";
  CalDAV.TimeZone.DSTRule         = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";
```

## Data Type

**string**

# TimezoneDSTRule Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) TimezoneDSTRule() (string, error)func (obj *CalDAV) SetTimezoneDSTRule(value string) error
```

## Default Value

""

## Remarks

This property defines the recurrence rule for the onset of this daylight savings time observance. Some specific requirements for the usage of [TimezoneDSTRule](#timezonedstrule-property-caldav-component) for this purpose include:

|  |  |
| --- | --- |
| FREQ | Frequency of the time zone onset. (Almost always "YEARLY") |
| BYMONTH | The month of the time zone onset. |
| BYDAY | The day of the time zone onset. Formatted as a number and a two-character day. "BYDAY=3SU" means the 3rd Sunday of the month. "BYDAY=-1SU" is the last Sunday of the month. |
| UNTIL | If the observance is known to have an effective end date, the "UNTIL" recurrence rule parameter MUST be used to specify the last valid onset of this observance (i.e., the UNTIL DATE-TIME will be equal to the last instance generated by the recurrence pattern). It MUST be specified in UTC time. |

 Note that the [TimezoneDSTStart](#timezonedststart-property-caldav-component) and [TimezoneDSTOffsetFrom](#timezonedstoffsetfrom-property-caldav-component) properties must be used when generating the onset DATE-TIME values (instances) from the [TimezoneDSTRule](#timezonedstrule-property-caldav-component)

For instance, in the USA Eastern Daylight time before 2007 started on the first Sunday of April. In 2007 Daylight time was changed to begin on the 2nd Sunday in March. Therefore, the UNTIL option should indicate the LAST time this rule will be observed. (2am on April 2nd, 2006). Such a time zone declaration would look like this:

```text
	CalDAV.time zone.DSTName = "EDT"
	CalDAV.time zone.DSTStart = "19870405T020000"
	CalDAV.time zone.DSTOffsetFrom = "-500"
	CalDAV.time zone.DSTOffsetTo = "-400"
	CalDAV.time zone.DSTRule = "FREQ=YEARLY;BYMONTH=4;BYDAY=1SU;UNTIL=20060402T070000Z"
```

## Data Type

**string**

# TimezoneDSTStart Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) TimezoneDSTStart() (string, error)func (obj *CalDAV) SetTimezoneDSTStart(value string) error
```

## Default Value

""

## Remarks

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

[TimezoneDSTStart](#timezonedststart-property-caldav-component), [TimezoneDSTOffsetFrom](#timezonedstoffsetfrom-property-caldav-component), and [TimezoneDSTOffsetTo](#timezonedstoffsetto-property-caldav-component) are all required to specify the daylight-savings time zone.

The following example shows the [CalTimezone](#Type_CalTimezone) set to Eastern time.

```text
  CalDAV.Timezone.TimezoneId      = "US-Eastern";
  CalDAV.Timezone.URL             = "http://zones.example.com/tz/America-New_York.ics"

  CalDAV.Timezone.StdName         = "Eastern Standard Time (US & Canada)";
  CalDAV.Timezone.StdStart        = "20071104T020000";
  CalDAV.Timezone.StdOffsetFrom   = "-400";
  CalDAV.Timezone.StdOffsetTo     = "-500";
  CalDAV.Timezone.StdRule         = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11";

  CalDAV.TimeZone.DSTName         = "Eastern Daylight Time (US & Canada)";
  CalDAV.TimeZone.DSTStart        = "20070311T020000";
  CalDAV.TimeZone.DSTOffsetFrom   = "-500";
  CalDAV.TimeZone.DSTOffsetTo     = "-400";
  CalDAV.TimeZone.DSTRule         = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";
```

## Data Type

**string**

# TimezoneLastModified Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) TimezoneLastModified() (string, error)func (obj *CalDAV) SetTimezoneLastModified(value string) error
```

## Default Value

""

## Remarks

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

## Data Type

**string**

# TimezoneStdName Property ([CalDAV](#caldav-component) Component)

The customary name for the standard time zone.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) TimezoneStdName() (string, error)func (obj *CalDAV) SetTimezoneStdName(value string) error
```

## Default Value

""

## Remarks

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

The following example shows the [CalTimezone](#Type_CalTimezone) set to Eastern time.

```text
  CalDAV.Timezone.TimezoneId      = "US-Eastern";
  CalDAV.Timezone.URL             = "http://zones.example.com/tz/America-New_York.ics"

  CalDAV.Timezone.StdName         = "Eastern Standard Time (US & Canada)";
  CalDAV.Timezone.StdStart        = "20071104T020000";
  CalDAV.Timezone.StdOffsetFrom   = "-400";
  CalDAV.Timezone.StdOffsetTo     = "-500";
  CalDAV.Timezone.StdRule         = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11";

  CalDAV.TimeZone.DSTName         = "Eastern Daylight Time (US & Canada)";
  CalDAV.TimeZone.DSTStart        = "20070311T020000";
  CalDAV.TimeZone.DSTOffsetFrom   = "-500";
  CalDAV.TimeZone.DSTOffsetTo     = "-400";
  CalDAV.TimeZone.DSTRule         = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";
```

## Data Type

**string**

# TimezoneStdOffsetFrom Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) TimezoneStdOffsetFrom() (string, error)func (obj *CalDAV) SetTimezoneStdOffsetFrom(value string) error
```

## Default Value

""

## Remarks

The UTC offset that is in use when the onset of this time zone observance begins. [TimezoneStdOffsetFrom](#timezonestdoffsetfrom-property-caldav-component) is combined with [TimezoneStdStart](#timezonestdstart-property-caldav-component) to define the effective onset for the standard-time time zone definition.

[TimezoneStdStart](#timezonestdstart-property-caldav-component), [TimezoneStdOffsetFrom](#timezonestdoffsetfrom-property-caldav-component), and [TimezoneStdOffsetTo](#timezonestdoffsetto-property-caldav-component) are all required to specify the standard-time time zone.

The following example shows the [CalTimezone](#Type_CalTimezone) set to Eastern time.

```text
  CalDAV.Timezone.TimezoneId      = "US-Eastern";
  CalDAV.Timezone.URL             = "http://zones.example.com/tz/America-New_York.ics"

  CalDAV.Timezone.StdName         = "Eastern Standard Time (US & Canada)";
  CalDAV.Timezone.StdStart        = "20071104T020000";
  CalDAV.Timezone.StdOffsetFrom   = "-400";
  CalDAV.Timezone.StdOffsetTo     = "-500";
  CalDAV.Timezone.StdRule         = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11";

  CalDAV.TimeZone.DSTName         = "Eastern Daylight Time (US & Canada)";
  CalDAV.TimeZone.DSTStart        = "20070311T020000";
  CalDAV.TimeZone.DSTOffsetFrom   = "-500";
  CalDAV.TimeZone.DSTOffsetTo     = "-400";
  CalDAV.TimeZone.DSTRule         = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";
```

## Data Type

**string**

# TimezoneStdOffsetTo Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) TimezoneStdOffsetTo() (string, error)func (obj *CalDAV) SetTimezoneStdOffsetTo(value string) error
```

## Default Value

""

## Remarks

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

[TimezoneStdStart](#timezonestdstart-property-caldav-component), [TimezoneStdOffsetFrom](#timezonestdoffsetfrom-property-caldav-component), and [TimezoneStdOffsetTo](#timezonestdoffsetto-property-caldav-component) are all required to specify the standard-time time zone.

The following example shows the [CalTimezone](#Type_CalTimezone) set to Eastern time.

```text
  CalDAV.Timezone.TimezoneId      = "US-Eastern";
  CalDAV.Timezone.URL             = "http://zones.example.com/tz/America-New_York.ics"

  CalDAV.Timezone.StdName         = "Eastern Standard Time (US & Canada)";
  CalDAV.Timezone.StdStart        = "20071104T020000";
  CalDAV.Timezone.StdOffsetFrom   = "-400";
  CalDAV.Timezone.StdOffsetTo     = "-500";
  CalDAV.Timezone.StdRule         = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11";

  CalDAV.TimeZone.DSTName         = "Eastern Daylight Time (US & Canada)";
  CalDAV.TimeZone.DSTStart        = "20070311T020000";
  CalDAV.TimeZone.DSTOffsetFrom   = "-500";
  CalDAV.TimeZone.DSTOffsetTo     = "-400";
  CalDAV.TimeZone.DSTRule         = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";
```

## Data Type

**string**

# TimezoneStdRule Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) TimezoneStdRule() (string, error)func (obj *CalDAV) SetTimezoneStdRule(value string) error
```

## Default Value

""

## Remarks

This property defines the recurrence rule for the onset of this standard time observance. Some specific requirements for the usage of [TimezoneDSTRule](#timezonedstrule-property-caldav-component) for this purpose include:

|  |  |
| --- | --- |
| FREQ | Frequency of the time zone onset. (Almost always "YEARLY") |
| BYMONTH | The month of the time zone onset. |
| BYDAY | The day of the time zone onset. Formatted as a number and a two-character day. "BYDAY=3SU" means the 3rd Sunday of the month. "BYDAY=-1SU" is the last Sunday of the month. |
| UNTIL | If the observance is known to have an effective end date, the "UNTIL" recurrence rule parameter MUST be used to specify the last valid onset of this observance (i.e., the UNTIL DATE-TIME will be equal to the last instance generated by the recurrence pattern). It MUST be specified in UTC time. |

 Note that the [TimezoneStdStart](#timezonestdstart-property-caldav-component) and [TimezoneStdOffsetFrom](#timezonestdoffsetfrom-property-caldav-component) properties must be used when generating the onset DATE-TIME values (instances) from the [TimezoneStdRule](#timezonestdrule-property-caldav-component)

For instance, in the USA Eastern Standard time before 2007 started on the last Sunday of October. In 2007 Standard time was changed to begin on the 1st Sunday in November. Therefore, the UNTIL option should indicate the LAST time this rule will be observed. (2am on October 29th, 2006). Such a time zone declaration would look like this:

```text
	CalDAV.time zone.StdName = "EST"
	CalDAV.time zone.StdStart = "19671029T020000"
	CalDAV.time zone.StdOffsetFrom = "-400"
	CalDAV.time zone.StdOffsetTo = "-500"
	CalDAV.time zone.StdRule = "FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU;UNTIL=20061029T060000Z"
```

## Data Type

**string**

# TimezoneStdStart Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) TimezoneStdStart() (string, error)func (obj *CalDAV) SetTimezoneStdStart(value string) error
```

## Default Value

""

## Remarks

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

[TimezoneStdStart](#timezonestdstart-property-caldav-component), [TimezoneStdOffsetFrom](#timezonestdoffsetfrom-property-caldav-component), and [TimezoneStdOffsetTo](#timezonestdoffsetto-property-caldav-component) are all required to specify the standard-time time zone.

The following example shows the [CalTimezone](#Type_CalTimezone) set to Eastern time.

```text
  CalDAV.Timezone.TimezoneId      = "US-Eastern";
  CalDAV.Timezone.URL             = "http://zones.example.com/tz/America-New_York.ics"

  CalDAV.Timezone.StdName         = "Eastern Standard Time (US & Canada)";
  CalDAV.Timezone.StdStart        = "20071104T020000";
  CalDAV.Timezone.StdOffsetFrom   = "-400";
  CalDAV.Timezone.StdOffsetTo     = "-500";
  CalDAV.Timezone.StdRule         = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11";

  CalDAV.TimeZone.DSTName         = "Eastern Daylight Time (US & Canada)";
  CalDAV.TimeZone.DSTStart        = "20070311T020000";
  CalDAV.TimeZone.DSTOffsetFrom   = "-500";
  CalDAV.TimeZone.DSTOffsetTo     = "-400";
  CalDAV.TimeZone.DSTRule         = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";
```

## Data Type

**string**

# TimezoneId Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) TimezoneId() (string, error)func (obj *CalDAV) SetTimezoneId(value string) error
```

## Default Value

""

## Remarks

This property specifies a text value that uniquely identifies this [CalTimezone](#Type_CalTimezone) calendar component.

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

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

## Data Type

**string**

# TimezoneURL Property ([CalDAV](#caldav-component) Component)

Optionally points to a published time zone definition.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) TimezoneURL() (string, error)func (obj *CalDAV) SetTimezoneURL(value string) error
```

## Default Value

""

## Remarks

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

## Data Type

**string**

# Transparency Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Transparency() (string, error)func (obj *CalDAV) SetTransparency(value string) error
```

## Default Value

""

## Remarks

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

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

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# UID Property ([CalDAV](#caldav-component) Component)

A persistent, globally unique identifier for the calendar event.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) UID() (string, error)func (obj *CalDAV) SetUID(value string) error
```

## Default Value

""

## Remarks

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

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

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

## Data Type

**string**

# URL Property ([CalDAV](#caldav-component) Component)

Location of the event resource on the CalDAV server.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) URL() (string, error)
```

## 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](#getcalendarreport-method-caldav-component) transaction.

This property is filled from the response to a [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

This property is read-only.

## Data Type

**string**

# User Property ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) User() (string, error)func (obj *CalDAV) SetUser(value string) error
```

## Default Value

""

## Remarks

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

If [AuthScheme](#authscheme-property-caldav-component) is set to HTTP Digest Authentication, the User and [Password](#password-property-caldav-component) properties are used to respond to the HTTP Digest Authentication challenge from the server.

If [AuthScheme](#authscheme-property-caldav-component) is set to NTLM, NTLM authentication will be attempted. If [AuthScheme](#authscheme-property-caldav-component) is set to NTLM, and User and [Password](#password-property-caldav-component) are empty, the struct will attempt to authenticate using the current user's credentials.

## Data Type

**string**

# AddCookie Method ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) AddCookie(CookieName string, CookieValue string) error
```

## Remarks

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

# AddCustomProperty Method ([CalDAV](#caldav-component) Component)

Adds a form variable and the corresponding value.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) AddCustomProperty(VarName string, VarValue string) error
```

## 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:**

```csharp
CalDAV.Reset()
CalDAV.AddCustomProperty("propname1", "propvalue1")
CalDAV.AddCustomProperty("propname2", "propvalue2")
```

 **Example using Custom Property arrays:**

```text
CalDAV.Reset()
CalDAV.CustomPropertyCount = 2
CalDAV.CustomPropertyName (0) = "propname1"
CalDAV.CustomPropertyValue(0) = "propvalue1"
CalDAV.CustomPropertyName (1) = "propname2"
CalDAV.CustomPropertyValue(1) = "propvalue2"
```

# Config Method ([CalDAV](#caldav-component) Component)

Sets or retrieves a configuration setting.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Config(ConfigurationString string) (string, error)
```

## Remarks

Config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-caldav-component) for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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](#config-settings-caldav-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# CopyEvent Method ([CalDAV](#caldav-component) Component)

Copy events to a new location.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CopyEvent(SourceResourceURI string, DestinationResourceURI string) error
```

## Remarks

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

This method is associated with the [Depth](#Depth) property. If [Depth](#Depth) is set to "0", the struct will copy only *SourceResourceURI*. If [Depth](#Depth) is set to "infinity", the struct will copy *SourceResourceURI* and its entire subtree to the relative locations.

If the user has acquired a [LockCalendar](#lockcalendar-method-caldav-component) of infinite depth on either *DestinationResourceURI* or any collection it is under, *SourceResourceURI* will be added to that lock.

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

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

```csharp
  CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/");
```

 Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the [CreateEvent](#createevent-method-caldav-component) method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the [UID](#uid-property-caldav-component) property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with [GetEvent](#getevent-method-caldav-component). For example:

```csharp
  CalDAV.UID = "1234567890";
  CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");
```

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the [CreateCalendar](#createcalendar-method-caldav-component) 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:

```csharp
  CalDAV.User = "username";
  CalDAV.Password = "password";

  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar");

  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");

  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
```

# CreateCalendar Method ([CalDAV](#caldav-component) Component)

Creates a new calendar collection resource.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CreateCalendar(ResourceURI string, DisplayName string, Description string) error
```

## Remarks

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

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

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

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

The following example shows how to create a simple new calendar collection resource with Yahoo Calendar.

```csharp

  calDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1", "My Display Name", "My Calendar Description);
```

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

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

```csharp
  CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/");
```

 Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the [CreateEvent](#createevent-method-caldav-component) method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the [UID](#uid-property-caldav-component) property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with [GetEvent](#getevent-method-caldav-component). For example:

```csharp
  CalDAV.UID = "1234567890";
  CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");
```

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

```csharp
  CalDAV.User = "username";
  CalDAV.Password = "password";

  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar");

  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");

  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
```

# CreateEvent Method ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) CreateEvent(ResourceURI string) error
```

## Remarks

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

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

The following properties are used when creating a request with CreateEvent or [ExportICS](#exportics-method-caldav-component), and will be filled after calling [GetEvent](#getevent-method-caldav-component) or [ImportICS](#importics-method-caldav-component). These will also be available from inside the [EventDetails](#eventdetails-event-caldav-component) event, which is fired for each event received from the CalDAV server in response to a [GetCalendarReport](#getcalendarreport-method-caldav-component).

- Alarms
- [Attendees](#attendees-property-caldav-component)
- [Categories](#categories-property-caldav-component)
- [Classification](#classification-property-caldav-component)
- [Completed](#completed-property-caldav-component)
- [Created](#Created)
- CustomProperties
- [Depth](#Depth)
- [Description](#description-property-caldav-component)
- [Duration](#duration-property-caldav-component)
- [EndDate](#enddate-property-caldav-component)
- [EventType](#eventtype-property-caldav-component)
- [LastModified](#lastmodified-property-caldav-component)
- [Location](#location-property-caldav-component)
- [Organizer](#organizer-property-caldav-component)
- [Priority](#priority-property-caldav-component)
- Recurrence
- [Sequence](#sequence-property-caldav-component)
- [StartDate](#startdate-property-caldav-component)
- [Status](#status-property-caldav-component)
- [Summary](#summary-property-caldav-component)
- [Timestamp](#timestamp-property-caldav-component)
- Timezone
- [Transparency](#transparency-property-caldav-component)
- [UID](#uid-property-caldav-component)
- [URL](#url-property-caldav-component)

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

```csharp
  CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/");
```

 Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

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

```csharp
  CalDAV.UID = "1234567890";
  CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");
```

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the [CreateCalendar](#createcalendar-method-caldav-component) 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:

```csharp
  CalDAV.User = "username";
  CalDAV.Password = "password";

  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar");

  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");

  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
```

# DeleteCalendar Method ([CalDAV](#caldav-component) Component)

Deletes a calendar collection resource.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) DeleteCalendar(ResourceURI string) error
```

## Remarks

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

The following example shows how to delete a calendar collection resource:

```csharp

  calDAV.DeleteCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1");
```

 In a NextCloud server, if all calendars are deleted, a new Personal calendar is automatically created.

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

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

```csharp
  CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/");
```

 Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the [CreateEvent](#createevent-method-caldav-component) method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the [UID](#uid-property-caldav-component) property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with [GetEvent](#getevent-method-caldav-component). For example:

```csharp
  CalDAV.UID = "1234567890";
  CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");
```

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the [CreateCalendar](#createcalendar-method-caldav-component) 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:

```csharp
  CalDAV.User = "username";
  CalDAV.Password = "password";

  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar");

  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");

  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
```

# DeleteEvent Method ([CalDAV](#caldav-component) Component)

Delete a resource or collection.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) DeleteEvent(ResourceURI string) error
```

## Remarks

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

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

```csharp
  CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/");
```

 Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the [CreateEvent](#createevent-method-caldav-component) method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the [UID](#uid-property-caldav-component) property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with [GetEvent](#getevent-method-caldav-component). For example:

```csharp
  CalDAV.UID = "1234567890";
  CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");
```

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the [CreateCalendar](#createcalendar-method-caldav-component) 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:

```csharp
  CalDAV.User = "username";
  CalDAV.Password = "password";

  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar");

  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");

  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
```

# DoEvents Method ([CalDAV](#caldav-component) Component)

This method processes events from the internal message queue.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) DoEvents() error
```

## Remarks

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

# ExportICS Method ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ExportICS() (string, error)
```

## Remarks

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

Note that if ExportICS is called immediately after a successful [GetEvent](#getevent-method-caldav-component), the unmodified calendar returned from the CalDAV server will be returned. However if any properties are changed between the [GetEvent](#getevent-method-caldav-component) and ExportICS calls, the struct will generate and return a brand new event.

The following properties are used when creating a request with [CreateEvent](#createevent-method-caldav-component) or ExportICS, and will be filled after calling [GetEvent](#getevent-method-caldav-component) or [ImportICS](#importics-method-caldav-component). These will also be available from inside the [EventDetails](#eventdetails-event-caldav-component) event, which is fired for each event received from the CalDAV server in response to a [GetCalendarReport](#getcalendarreport-method-caldav-component).

- Alarms
- [Attendees](#attendees-property-caldav-component)
- [Categories](#categories-property-caldav-component)
- [Classification](#classification-property-caldav-component)
- [Completed](#completed-property-caldav-component)
- [Created](#Created)
- CustomProperties
- [Depth](#Depth)
- [Description](#description-property-caldav-component)
- [Duration](#duration-property-caldav-component)
- [EndDate](#enddate-property-caldav-component)
- [EventType](#eventtype-property-caldav-component)
- [LastModified](#lastmodified-property-caldav-component)
- [Location](#location-property-caldav-component)
- [Organizer](#organizer-property-caldav-component)
- [Priority](#priority-property-caldav-component)
- Recurrence
- [Sequence](#sequence-property-caldav-component)
- [StartDate](#startdate-property-caldav-component)
- [Status](#status-property-caldav-component)
- [Summary](#summary-property-caldav-component)
- [Timestamp](#timestamp-property-caldav-component)
- Timezone
- [Transparency](#transparency-property-caldav-component)
- [UID](#uid-property-caldav-component)
- [URL](#url-property-caldav-component)

# GetCalendarOptions Method ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) GetCalendarOptions(ResourceURI string) error
```

## 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](#header-event-caldav-component) 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:

|  |  |
| --- | --- |
| Field | Value |
| Allow | OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, COPY, MOVE |
| Allow | PROPFIND, PROPPATCH, LOCK, UNLOCK, REPORT, ACL |
| DAV | 1, 2, access-control, calendar-access |
| Date | Sat, 11 Nov 2006 09:32:12 GMT |
| Content-Length | 0 |

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

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

```csharp
  CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/");
```

 Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the [CreateEvent](#createevent-method-caldav-component) method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the [UID](#uid-property-caldav-component) property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with [GetEvent](#getevent-method-caldav-component). For example:

```csharp
  CalDAV.UID = "1234567890";
  CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");
```

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the [CreateCalendar](#createcalendar-method-caldav-component) 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:

```csharp
  CalDAV.User = "username";
  CalDAV.Password = "password";

  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar");

  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");

  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
```

# GetCalendarReport Method ([CalDAV](#caldav-component) Component)

Generates a report on the indicated calendar collection resource.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) GetCalendarReport(ResourceURI string) error
```

## 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 struct, and information about the individual events contained within shall be fired in the [EventDetails](#eventdetails-event-caldav-component) event.

The following properties are used when creating a request with [CreateEvent](#createevent-method-caldav-component) or [ExportICS](#exportics-method-caldav-component), and will be filled after calling [GetEvent](#getevent-method-caldav-component) or [ImportICS](#importics-method-caldav-component). These will also be available from inside the [EventDetails](#eventdetails-event-caldav-component) event, which is fired for each event received from the CalDAV server in response to a GetCalendarReport.

- Alarms
- [Attendees](#attendees-property-caldav-component)
- [Categories](#categories-property-caldav-component)
- [Classification](#classification-property-caldav-component)
- [Completed](#completed-property-caldav-component)
- [Created](#Created)
- CustomProperties
- [Depth](#Depth)
- [Description](#description-property-caldav-component)
- [Duration](#duration-property-caldav-component)
- [EndDate](#enddate-property-caldav-component)
- [EventType](#eventtype-property-caldav-component)
- [LastModified](#lastmodified-property-caldav-component)
- [Location](#location-property-caldav-component)
- [Organizer](#organizer-property-caldav-component)
- [Priority](#priority-property-caldav-component)
- Recurrence
- [Sequence](#sequence-property-caldav-component)
- [StartDate](#startdate-property-caldav-component)
- [Status](#status-property-caldav-component)
- [Summary](#summary-property-caldav-component)
- [Timestamp](#timestamp-property-caldav-component)
- Timezone
- [Transparency](#transparency-property-caldav-component)
- [UID](#uid-property-caldav-component)
- [URL](#url-property-caldav-component)

For example:

```text
  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](#eventdetails-event-caldav-component) event will print the start and end time as well as the summary for each event:

```text
	Private Sub CalDAV_EventDetails(ResourceURI As String, ResponseStatus As String, ETag As String, CalendarData As String, Summary As String)
		Debug.Print Summary & ": " & CalDAV.StartDate & " to " & CalDAV.EndDate
	End Sub
```

 The output from the above code will look something like this:

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

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

```csharp
  CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/");
```

 Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the [CreateEvent](#createevent-method-caldav-component) method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the [UID](#uid-property-caldav-component) property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with [GetEvent](#getevent-method-caldav-component). For example:

```csharp
  CalDAV.UID = "1234567890";
  CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");
```

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the [CreateCalendar](#createcalendar-method-caldav-component) 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:

```csharp
  CalDAV.User = "username";
  CalDAV.Password = "password";

  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar");

  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");

  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
```

# GetEvent Method ([CalDAV](#caldav-component) Component)

Retrieves a single event from the CalDAV server.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) GetEvent(ResourceURI string) error
```

## 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](#getcalendarreport-method-caldav-component) method along with the ReportFilter property to find it.)

The event will be retrieved using the WebDAV *GET* method. The full response is delivered through the [Transfer](#transfer-event-caldav-component) event and the HTTP response headers through the [Header](#header-event-caldav-component) event. After an event is retrieved with this method, the struct parses the calendar data into properties. You may then edit these properties and use [CreateEvent](#createevent-method-caldav-component) to update the calendar event resource.

The following properties are used when creating a request with [CreateEvent](#createevent-method-caldav-component) or [ExportICS](#exportics-method-caldav-component), and will be filled after calling GetEvent or [ImportICS](#importics-method-caldav-component). These will also be available from inside the [EventDetails](#eventdetails-event-caldav-component) event, which is fired for each event received from the CalDAV server in response to a [GetCalendarReport](#getcalendarreport-method-caldav-component).

- Alarms
- [Attendees](#attendees-property-caldav-component)
- [Categories](#categories-property-caldav-component)
- [Classification](#classification-property-caldav-component)
- [Completed](#completed-property-caldav-component)
- [Created](#Created)
- CustomProperties
- [Depth](#Depth)
- [Description](#description-property-caldav-component)
- [Duration](#duration-property-caldav-component)
- [EndDate](#enddate-property-caldav-component)
- [EventType](#eventtype-property-caldav-component)
- [LastModified](#lastmodified-property-caldav-component)
- [Location](#location-property-caldav-component)
- [Organizer](#organizer-property-caldav-component)
- [Priority](#priority-property-caldav-component)
- Recurrence
- [Sequence](#sequence-property-caldav-component)
- [StartDate](#startdate-property-caldav-component)
- [Status](#status-property-caldav-component)
- [Summary](#summary-property-caldav-component)
- [Timestamp](#timestamp-property-caldav-component)
- Timezone
- [Transparency](#transparency-property-caldav-component)
- [UID](#uid-property-caldav-component)
- [URL](#url-property-caldav-component)

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

```csharp
  CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/");
```

 Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

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

```csharp
  CalDAV.UID = "1234567890";
  CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");
```

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the [CreateCalendar](#createcalendar-method-caldav-component) 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:

```csharp
  CalDAV.User = "username";
  CalDAV.Password = "password";

  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar");

  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");

  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
```

# GetFreeBusyReport Method ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) GetFreeBusyReport(ResourceURI string) error
```

## 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](#freebusy-event-caldav-component) 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](#reportfilterstartdate-property-caldav-component) property is required for a Free/Busy report. The [ReportFilterEndDate](#reportfilterenddate-property-caldav-component) property is optional. These are the only two ReportFilters used by the GetFreeBusyReport request, all other filters will be ignored.

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

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

```csharp
  CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/");
```

 Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the [CreateEvent](#createevent-method-caldav-component) method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the [UID](#uid-property-caldav-component) property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with [GetEvent](#getevent-method-caldav-component). For example:

```csharp
  CalDAV.UID = "1234567890";
  CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");
```

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the [CreateCalendar](#createcalendar-method-caldav-component) 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:

```csharp
  CalDAV.User = "username";
  CalDAV.Password = "password";

  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar");

  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");

  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
```

# ImportICS Method ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ImportICS(CalendarData string) error
```

## Remarks

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

As the calendar data is imported, the struct will scan *CalendarData* for any calendar events. Each time a calendar event is discovered, the [EventDetails](#eventdetails-event-caldav-component) 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](#caldav-component) Component)

This method interrupts the current method.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Interrupt() error
```

## Remarks

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

# ListCalendars Method ([CalDAV](#caldav-component) Component)

Lists all calendars that the current user can access.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) ListCalendars(baseURL string) error
```

## Remarks

This method lists all calendars the user can access.

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

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

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

```csharp
calDAV.ListCalendars("https://apidata.googleusercontent.com/caldav/v2");

for (int i = 0; i < calDAV.Calendars.Count; i++) {
  string url = calDAV.Calendars[i].URL;
  string displayName = calDAV.Calendars[i].DisplayName;
  ...
}
```

# LockCalendar Method ([CalDAV](#caldav-component) Component)

Obtain a lock for a specified calendar resource.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) LockCalendar(ResourceURI string) error
```

## 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:

|  |  |
| --- | --- |
| [LockOwner](#lockowner-property-caldav-component) | The principle that will own the lock. |
| [LockScope](#lockscope-property-caldav-component) | The scope of the lock. The struct only currently supports locks of scope "exclusive" and "shared". |
| [LockTimeout](#locktimeout-property-caldav-component) | The amount of time that the lock is allowed to exist before ResourceURI is automatically unlocked by the server. |
| [LockToken](#locktoken-property-caldav-component) | The lock itself. If the user sets this before making the request, the timeout on the existing lock will be refreshed (reset to 0). Otherwise, a new set of lock token will be returned. |
| [LockType](#locktype-property-caldav-component) | The type of lock. The struct only currently supports of type "write". |

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

This method is associated with the [Depth](#Depth) property. If [Depth](#Depth) is set to "0", the struct will lock only *ResourceURI* and its properties. If [Depth](#Depth) is set to "infinity", the struct will lock *ResourceURI* and its entire subtree.

If [MoveEvent](#moveevent-method-caldav-component) or [CopyEvent](#copyevent-method-caldav-component) 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](#unlockcalendar-method-caldav-component) requests, the server does not respect resource locks (either on events or on the entire calendar). The Google CalDAV sever does not support either of these requests, and will respond with an HTTP protocol error: 405 Method Not Allowed. Also, neither Yahoo nor Google CalDAV servers support copying or moving calendar resources.

# MoveEvent Method ([CalDAV](#caldav-component) Component)

Moves one calendar resource to a new location.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) MoveEvent(SourceResourceURI string, DestinationResourceURI string) error
```

## 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](#Depth) property. If [Depth](#Depth) is set to "0", the struct will move only *SourceResourceURI*. If [Depth](#Depth) is set to "infinity", the struct will move *SourceResourceURI* and its entire subtree to locations relative to it.

If the user has acquired a lock of infinite depth (via [LockCalendar](#lockcalendar-method-caldav-component)) on either *DestinationResourceURI* or any collection it is under, *SourceResourceURI* will be added to that lock.

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

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

```csharp
  CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/");
```

 Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the [CreateEvent](#createevent-method-caldav-component) method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the [UID](#uid-property-caldav-component) property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with [GetEvent](#getevent-method-caldav-component). For example:

```csharp
  CalDAV.UID = "1234567890";
  CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");
```

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the [CreateCalendar](#createcalendar-method-caldav-component) 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:

```csharp
  CalDAV.User = "username";
  CalDAV.Password = "password";

  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar");

  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");

  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
```

# Reset Method ([CalDAV](#caldav-component) Component)

Reset the class.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) Reset() error
```

## Remarks

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

# SendCustomRequest Method ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) SendCustomRequest(HttpMethod string, Url string, RequestBody string) error
```

## Remarks

Allows users to send personalized HTTP commands to a CalDAV server. It requires three string parameters: *HttpMethod* indicates the desired action (e.g., "GET," "POST"), *Url* specifies the target resource's URL, and *RequestBody* includes data sent with the request. Here is an example of how to create a calendar event:

```csharp
  string httpMethod = "MKCALENDAR";
  string url = "https://caldav.calendar.yahoo.com/dav/user/Calendar/CreateCalendarTest";
  string requestBody = "BEGIN:VCALENDAR
                        PRODID:/n software IPWorks CalDAV Component - www.nsoftware.com
                        VERSION:2.0
                        BEGIN:VEVENT
                        UID: uidValue
                        DTSTAMP: dtstampValue
                        DTSTART: dtstartValue
                        DTEND: dtendValue
                        PRIORITY:0
                        SEQUENCE:0
                        SUMMARY:TEST
                        END:VEVENT
                        END:VCALENDAR"
  calDAV.SendCustomRequest(httpMethod, url, requestBody);
```

# UnLockCalendar Method ([CalDAV](#caldav-component) Component)

Unlocks a calendar resource.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) UnLockCalendar(ResourceURI string) error
```

## Remarks

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

# UpdateCalendar Method ([CalDAV](#caldav-component) Component)

Updates a calendar collection resource.

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) UpdateCalendar(ResourceURI string, CalIndex int32) error
```

## Remarks

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

The following example shows how to update a calendar collection resource:

```csharp
  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1", "test", "test");

  calDAV.Calendars[0].DisplayName = "test_updated";
  calDAV.Calendars[0].Color = "#000001";
  calDAV.UpdateCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1", 0);
```

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

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

```csharp
  CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/");
```

 Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the [CreateEvent](#createevent-method-caldav-component) method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the [UID](#uid-property-caldav-component) property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with [GetEvent](#getevent-method-caldav-component). For example:

```csharp
  CalDAV.UID = "1234567890";
  CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");
```

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the [CreateCalendar](#createcalendar-method-caldav-component) 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:

```csharp
  CalDAV.User = "username";
  CalDAV.Password = "password";

  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar");

  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");

  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
```

# UpdateEvent Method ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
func (obj *CalDAV) UpdateEvent(ResourceURI string) error
```

## Remarks

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

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

The following properties are used when creating a request with [CreateEvent](#createevent-method-caldav-component) or [ExportICS](#exportics-method-caldav-component), and will be filled after calling [GetEvent](#getevent-method-caldav-component) or [ImportICS](#importics-method-caldav-component). These will also be available from inside the [EventDetails](#eventdetails-event-caldav-component) event, which is fired for each event received from the CalDAV server in response to a [GetCalendarReport](#getcalendarreport-method-caldav-component).

- Alarms
- [Attendees](#attendees-property-caldav-component)
- [Categories](#categories-property-caldav-component)
- [Classification](#classification-property-caldav-component)
- [Completed](#completed-property-caldav-component)
- [Created](#Created)
- CustomProperties
- [Depth](#Depth)
- [Description](#description-property-caldav-component)
- [Duration](#duration-property-caldav-component)
- [EndDate](#enddate-property-caldav-component)
- [EventType](#eventtype-property-caldav-component)
- [LastModified](#lastmodified-property-caldav-component)
- [Location](#location-property-caldav-component)
- [Organizer](#organizer-property-caldav-component)
- [Priority](#priority-property-caldav-component)
- Recurrence
- [Sequence](#sequence-property-caldav-component)
- [StartDate](#startdate-property-caldav-component)
- [Status](#status-property-caldav-component)
- [Summary](#summary-property-caldav-component)
- [Timestamp](#timestamp-property-caldav-component)
- Timezone
- [Transparency](#transparency-property-caldav-component)
- [UID](#uid-property-caldav-component)
- [URL](#url-property-caldav-component)

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

```csharp
  CalDAV.GetCalendarReport("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/");
```

 Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the [CreateEvent](#createevent-method-caldav-component) method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the [UID](#uid-property-caldav-component) property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with [GetEvent](#getevent-method-caldav-component). For example:

```csharp
  CalDAV.UID = "1234567890";
  CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/username@gmail.com/events/1234567890.ics");
```

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the [CreateCalendar](#createcalendar-method-caldav-component) 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:

```csharp
  CalDAV.User = "username";
  CalDAV.Password = "password";

  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My Hockey Calendar");

  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");

  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
```

# Connected Event ([CalDAV](#caldav-component) Component)

Fired immediately after a connection completes (or fails).

## Syntax

*Go Syntax*

```text
// CalDAVConnectedEventArgs carries the CalDAV Connected event's parameters.
type CalDAVConnectedEventArgs struct {...}

func (args *CalDAVConnectedEventArgs) StatusCode() int32
func (args *CalDAVConnectedEventArgs) Description() string
// CalDAVConnectedEvent defines the signature of the CalDAV Connected event's handler function.
type CalDAVConnectedEvent func(sender *CalDAV, args *CalDAVConnectedEventArgs)

func (obj *CalDAV) GetOnConnectedHandler() CalDAVConnectedEvent
func (obj *CalDAV) SetOnConnectedHandler(handlerFunc CalDAVConnectedEvent)
```

## 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](#trappable-errors-caldav-component) section for more information.

# ConnectionStatus Event ([CalDAV](#caldav-component) Component)

Fired to indicate changes in the connection state.

## Syntax

*Go Syntax*

```text
// CalDAVConnectionStatusEventArgs carries the CalDAV ConnectionStatus event's parameters.
type CalDAVConnectionStatusEventArgs struct {...}

func (args *CalDAVConnectionStatusEventArgs) ConnectionEvent() string
func (args *CalDAVConnectionStatusEventArgs) StatusCode() int32
func (args *CalDAVConnectionStatusEventArgs) Description() string
// CalDAVConnectionStatusEvent defines the signature of the CalDAV ConnectionStatus event's handler function.
type CalDAVConnectionStatusEvent func(sender *CalDAV, args *CalDAVConnectionStatusEventArgs)

func (obj *CalDAV) GetOnConnectionStatusHandler() CalDAVConnectionStatusEvent
func (obj *CalDAV) SetOnConnectionStatusHandler(handlerFunc CalDAVConnectionStatusEvent)
```

## Remarks

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

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

|  |  |
| --- | --- |
|  | Firewall connection complete. |
|  | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). |
|  | Remote host connection complete. |
|  | Remote host disconnected. |
|  | SSL or S/Shell connection broken. |
|  | Firewall host disconnected. |

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

# Disconnected Event ([CalDAV](#caldav-component) Component)

Fired when a connection is closed.

## Syntax

*Go Syntax*

```text
// CalDAVDisconnectedEventArgs carries the CalDAV Disconnected event's parameters.
type CalDAVDisconnectedEventArgs struct {...}

func (args *CalDAVDisconnectedEventArgs) StatusCode() int32
func (args *CalDAVDisconnectedEventArgs) Description() string
// CalDAVDisconnectedEvent defines the signature of the CalDAV Disconnected event's handler function.
type CalDAVDisconnectedEvent func(sender *CalDAV, args *CalDAVDisconnectedEventArgs)

func (obj *CalDAV) GetOnDisconnectedHandler() CalDAVDisconnectedEvent
func (obj *CalDAV) SetOnDisconnectedHandler(handlerFunc CalDAVDisconnectedEvent)
```

## 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](#trappable-errors-caldav-component) section for more information.

# EndTransfer Event ([CalDAV](#caldav-component) Component)

This event is fired when a document finishes transferring.

## Syntax

*Go Syntax*

```text
// CalDAVEndTransferEventArgs carries the CalDAV EndTransfer event's parameters.
type CalDAVEndTransferEventArgs struct {...}

func (args *CalDAVEndTransferEventArgs) Direction() int32
// CalDAVEndTransferEvent defines the signature of the CalDAV EndTransfer event's handler function.
type CalDAVEndTransferEvent func(sender *CalDAV, args *CalDAVEndTransferEventArgs)

func (obj *CalDAV) GetOnEndTransferHandler() CalDAVEndTransferEvent
func (obj *CalDAV) SetOnEndTransferHandler(handlerFunc CalDAVEndTransferEvent)
```

## 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](#caldav-component) Component)

Fired when information is available about errors during data delivery.

## Syntax

*Go Syntax*

```text
// CalDAVErrorEventArgs carries the CalDAV Error event's parameters.
type CalDAVErrorEventArgs struct {...}

func (args *CalDAVErrorEventArgs) ErrorCode() int32
func (args *CalDAVErrorEventArgs) Description() string
// CalDAVErrorEvent defines the signature of the CalDAV Error event's handler function.
type CalDAVErrorEvent func(sender *CalDAV, args *CalDAVErrorEventArgs)

func (obj *CalDAV) GetOnErrorHandler() CalDAVErrorEvent
func (obj *CalDAV) SetOnErrorHandler(handlerFunc CalDAVErrorEvent)
```

## Remarks

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

The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-caldav-component) section.

# EventDetails Event ([CalDAV](#caldav-component) Component)

Fires for each calendar event received.

## Syntax

*Go Syntax*

```text
// CalDAVEventDetailsEventArgs carries the CalDAV EventDetails event's parameters.
type CalDAVEventDetailsEventArgs struct {...}

func (args *CalDAVEventDetailsEventArgs) ResourceURI() string
func (args *CalDAVEventDetailsEventArgs) ResponseStatus() string
func (args *CalDAVEventDetailsEventArgs) ETag() string
func (args *CalDAVEventDetailsEventArgs) CalendarData() string
func (args *CalDAVEventDetailsEventArgs) Summary() string
// CalDAVEventDetailsEvent defines the signature of the CalDAV EventDetails event's handler function.
type CalDAVEventDetailsEvent func(sender *CalDAV, args *CalDAVEventDetailsEventArgs)

func (obj *CalDAV) GetOnEventDetailsHandler() CalDAVEventDetailsEvent
func (obj *CalDAV) SetOnEventDetailsHandler(handlerFunc CalDAVEventDetailsEvent)
```

## Remarks

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

- Alarms
- [Attendees](#attendees-property-caldav-component)
- [Categories](#categories-property-caldav-component)
- [Classification](#classification-property-caldav-component)
- [Completed](#completed-property-caldav-component)
- [Created](#Created)
- CustomProperties
- [Depth](#Depth)
- [Description](#description-property-caldav-component)
- [Duration](#duration-property-caldav-component)
- [EndDate](#enddate-property-caldav-component)
- [RelatedTo](#relatedto-property-caldav-component)
- [EventType](#eventtype-property-caldav-component)
- [LastModified](#lastmodified-property-caldav-component)
- [Location](#location-property-caldav-component)
- [Organizer](#organizer-property-caldav-component)
- [Priority](#priority-property-caldav-component)
- Recurrence
- [Sequence](#sequence-property-caldav-component)
- [StartDate](#startdate-property-caldav-component)
- [Status](#status-property-caldav-component)
- [Summary](#summary-property-caldav-component)
- [Timestamp](#timestamp-property-caldav-component)
- Timezone
- [Transparency](#transparency-property-caldav-component)
- [UID](#uid-property-caldav-component)
- [URL](#url-property-caldav-component)

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](#reportfilterreturncalendardata-property-caldav-component) 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](#url-property-caldav-component) property are not the same. The [URL](#url-property-caldav-component) 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](#url-property-caldav-component) to match the *ResourceURI*, but the [URL](#url-property-caldav-component) 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](#status-property-caldav-component) are not the same. [Status](#status-property-caldav-component) 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](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
// CalDAVFreeBusyEventArgs carries the CalDAV FreeBusy event's parameters.
type CalDAVFreeBusyEventArgs struct {...}

func (args *CalDAVFreeBusyEventArgs) BusyType() string
func (args *CalDAVFreeBusyEventArgs) BusyRange() string
// CalDAVFreeBusyEvent defines the signature of the CalDAV FreeBusy event's handler function.
type CalDAVFreeBusyEvent func(sender *CalDAV, args *CalDAVFreeBusyEventArgs)

func (obj *CalDAV) GetOnFreeBusyHandler() CalDAVFreeBusyEvent
func (obj *CalDAV) SetOnFreeBusyHandler(handlerFunc CalDAVFreeBusyEvent)
```

## Remarks

This event fires for each FREEBUSY element received in response to a [GetFreeBusyReport](#getfreebusyreport-method-caldav-component) 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](#caldav-component) Component)

Fired every time a header line comes in.

## Syntax

*Go Syntax*

```text
// CalDAVHeaderEventArgs carries the CalDAV Header event's parameters.
type CalDAVHeaderEventArgs struct {...}

func (args *CalDAVHeaderEventArgs) Field() string
func (args *CalDAVHeaderEventArgs) Value() string
// CalDAVHeaderEvent defines the signature of the CalDAV Header event's handler function.
type CalDAVHeaderEvent func(sender *CalDAV, args *CalDAVHeaderEventArgs)

func (obj *CalDAV) GetOnHeaderHandler() CalDAVHeaderEvent
func (obj *CalDAV) SetOnHeaderHandler(handlerFunc CalDAVHeaderEvent)
```

## 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](#caldav-component) Component)

Fired once for each log message.

## Syntax

*Go Syntax*

```text
// CalDAVLogEventArgs carries the CalDAV Log event's parameters.
type CalDAVLogEventArgs struct {...}

func (args *CalDAVLogEventArgs) LogLevel() int32
func (args *CalDAVLogEventArgs) Message() string
func (args *CalDAVLogEventArgs) LogType() string
// CalDAVLogEvent defines the signature of the CalDAV Log event's handler function.
type CalDAVLogEvent func(sender *CalDAV, args *CalDAVLogEventArgs)

func (obj *CalDAV) GetOnLogHandler() CalDAVLogEvent
func (obj *CalDAV) SetOnLogHandler(handlerFunc CalDAVLogEvent)
```

## Remarks

This event is fired once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

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

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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](#caldav-component) Component)

Fired when a redirection is received from the server.

## Syntax

*Go Syntax*

```text
// CalDAVRedirectEventArgs carries the CalDAV Redirect event's parameters.
type CalDAVRedirectEventArgs struct {...}

func (args *CalDAVRedirectEventArgs) Location() string
func (args *CalDAVRedirectEventArgs) Accept() bool
func (args *CalDAVRedirectEventArgs) SetAccept(value bool)

// CalDAVRedirectEvent defines the signature of the CalDAV Redirect event's handler function.
type CalDAVRedirectEvent func(sender *CalDAV, args *CalDAVRedirectEventArgs)

func (obj *CalDAV) GetOnRedirectHandler() CalDAVRedirectEvent
func (obj *CalDAV) SetOnRedirectHandler(handlerFunc CalDAVRedirectEvent)
```

## 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 struct fails with an error. *Location* is the location to which the client is being redirected. Further control over redirection is provided in the [FollowRedirects](#followredirects-property-caldav-component) property.

# SetCookie Event ([CalDAV](#caldav-component) Component)

Fired for every cookie set by the server.

## Syntax

*Go Syntax*

```text
// CalDAVSetCookieEventArgs carries the CalDAV SetCookie event's parameters.
type CalDAVSetCookieEventArgs struct {...}

func (args *CalDAVSetCookieEventArgs) Name() string
func (args *CalDAVSetCookieEventArgs) Value() string
func (args *CalDAVSetCookieEventArgs) Expires() string
func (args *CalDAVSetCookieEventArgs) Domain() string
func (args *CalDAVSetCookieEventArgs) Path() string
func (args *CalDAVSetCookieEventArgs) Secure() bool
// CalDAVSetCookieEvent defines the signature of the CalDAV SetCookie event's handler function.
type CalDAVSetCookieEvent func(sender *CalDAV, args *CalDAVSetCookieEventArgs)

func (obj *CalDAV) GetOnSetCookieHandler() CalDAVSetCookieEvent
func (obj *CalDAV) SetOnSetCookieHandler(handlerFunc CalDAVSetCookieEvent)
```

## Remarks

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

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

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

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

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

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

# SSLServerAuthentication Event ([CalDAV](#caldav-component) Component)

Fired after the server presents its certificate to the client.

## Syntax

*Go Syntax*

```text
// CalDAVSSLServerAuthenticationEventArgs carries the CalDAV SSLServerAuthentication event's parameters.
type CalDAVSSLServerAuthenticationEventArgs struct {...}

func (args *CalDAVSSLServerAuthenticationEventArgs) CertEncoded() []byte
func (args *CalDAVSSLServerAuthenticationEventArgs) CertSubject() string
func (args *CalDAVSSLServerAuthenticationEventArgs) CertIssuer() string
func (args *CalDAVSSLServerAuthenticationEventArgs) Status() string
func (args *CalDAVSSLServerAuthenticationEventArgs) Accept() bool
func (args *CalDAVSSLServerAuthenticationEventArgs) SetAccept(value bool)

// CalDAVSSLServerAuthenticationEvent defines the signature of the CalDAV SSLServerAuthentication event's handler function.
type CalDAVSSLServerAuthenticationEvent func(sender *CalDAV, args *CalDAVSSLServerAuthenticationEventArgs)

func (obj *CalDAV) GetOnSSLServerAuthenticationHandler() CalDAVSSLServerAuthenticationEvent
func (obj *CalDAV) SetOnSSLServerAuthenticationHandler(handlerFunc CalDAVSSLServerAuthenticationEvent)
```

## 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](#caldav-component) Component)

Fired when secure connection progress messages are available.

## Syntax

*Go Syntax*

```text
// CalDAVSSLStatusEventArgs carries the CalDAV SSLStatus event's parameters.
type CalDAVSSLStatusEventArgs struct {...}

func (args *CalDAVSSLStatusEventArgs) Message() string
// CalDAVSSLStatusEvent defines the signature of the CalDAV SSLStatus event's handler function.
type CalDAVSSLStatusEvent func(sender *CalDAV, args *CalDAVSSLStatusEventArgs)

func (obj *CalDAV) GetOnSSLStatusHandler() CalDAVSSLStatusEvent
func (obj *CalDAV) SetOnSSLStatusHandler(handlerFunc CalDAVSSLStatusEvent)
```

## Remarks

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

# StartTransfer Event ([CalDAV](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
// CalDAVStartTransferEventArgs carries the CalDAV StartTransfer event's parameters.
type CalDAVStartTransferEventArgs struct {...}

func (args *CalDAVStartTransferEventArgs) Direction() int32
// CalDAVStartTransferEvent defines the signature of the CalDAV StartTransfer event's handler function.
type CalDAVStartTransferEvent func(sender *CalDAV, args *CalDAVStartTransferEventArgs)

func (obj *CalDAV) GetOnStartTransferHandler() CalDAVStartTransferEvent
func (obj *CalDAV) SetOnStartTransferHandler(handlerFunc CalDAVStartTransferEvent)
```

## 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](#caldav-component) Component)

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

## Syntax

*Go Syntax*

```text
// CalDAVStatusEventArgs carries the CalDAV Status event's parameters.
type CalDAVStatusEventArgs struct {...}

func (args *CalDAVStatusEventArgs) HTTPVersion() string
func (args *CalDAVStatusEventArgs) StatusCode() int32
func (args *CalDAVStatusEventArgs) Description() string
// CalDAVStatusEvent defines the signature of the CalDAV Status event's handler function.
type CalDAVStatusEvent func(sender *CalDAV, args *CalDAVStatusEventArgs)

func (obj *CalDAV) GetOnStatusHandler() CalDAVStatusEvent
func (obj *CalDAV) SetOnStatusHandler(handlerFunc CalDAVStatusEvent)
```

## 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](#caldav-component) Component)

Fired while a document transfers (delivers document).

## Syntax

*Go Syntax*

```text
// CalDAVTransferEventArgs carries the CalDAV Transfer event's parameters.
type CalDAVTransferEventArgs struct {...}

func (args *CalDAVTransferEventArgs) Direction() int32
func (args *CalDAVTransferEventArgs) BytesTransferred() int64
func (args *CalDAVTransferEventArgs) PercentDone() int32
func (args *CalDAVTransferEventArgs) Text() []byte
// CalDAVTransferEvent defines the signature of the CalDAV Transfer event's handler function.
type CalDAVTransferEvent func(sender *CalDAV, args *CalDAVTransferEventArgs)

func (obj *CalDAV) GetOnTransferHandler() CalDAVTransferEvent
func (obj *CalDAV) SetOnTransferHandler(handlerFunc CalDAVTransferEvent)
```

## Remarks

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

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

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

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

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

# Config Settings ([CalDAV](#caldav-component) Component)

 The struct accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the [Config](#config-method-caldav-component) method.

### CalDAV Config Settings

**AttendeeFormat**: Specifies the format of the Attendees property. The following values are supported:

|  |  |
| --- | --- |
| 0 (default) | Attendee property is formatted as a comma-separated list |
| 1 | Attendee property is formatted as provided from the server |

 This setting determines the format of [Attendees](#attendees-property-caldav-component) after calling [GetEvent](#getevent-method-caldav-component).

When [AttendeeFormat](#AttendeeFormat) is set to 0, the [Attendees](#attendees-property-caldav-component) property is retrieved as a comma separated list, where each email address is in the mailto URI format (as defined in RFC2368). For instance:

```csharp
  calDAV.Config("AttendeeFormat=0");
  calDAV.GetEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");
  Console.WriteLine(calDAV.Attendees);

  //outputs:
  // mailto:johnsmith@example.com,mailto:janedoe@test.com
```

 When [AttendeeFormat](#AttendeeFormat) is set to 1, the [Attendees](#attendees-property-caldav-component) property is retrieved in the raw format provided from the server. For instance:

```csharp
  calDAV.Config("AttendeeFormat=1");
  calDAV.GetEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");
  Console.WriteLine(calDAV.Attendees);

  //outputs:
  // CN=johnsmith;CUTYPE=INDIVIDUAL;PARTSTAT=NEEDS-ACTION;ROLE=REQ-PARTICIPANT;RSVP=TRUE;LANGUAGE=en;SCHEDULE-STATUS=1.0:mailto:johnsmith@example.com,
  // CN=janedoe;CUTYPE=INDIVIDUAL;PARTSTAT=NEEDS-ACTION;ROLE=REQ-PARTICIPANT;RSVP=TRUE;LANGUAGE=en;SCHEDULE-STATUS=1.0:mailto:janedoe@test.com
```

 Note: the format may vary when [AttendeeFormat](#AttendeeFormat) is set to 1.

**AuthScheme**: The authentication scheme to use for server authorization.This setting is used to support non-standard CalDAV server authentication. The following values are supported:

|  |  |
| --- | --- |
| 0 | Basic |
| 1 | Digest |
| 2 | Proprietary |
| 3 | None |
| 4 | NTLM |

 Use the AuthScheme setting to tell the struct which type of authorization to perform when the [User](#user-property-caldav-component) and [Password](#password-property-caldav-component) properties are set. By default, CalDav servers use Basic authentication, and if the [User](#user-property-caldav-component) and [Password](#password-property-caldav-component) properties are set, the struct will attempt basic authentication. Digest, NTLM, and Negotiate authentication are also available to support custom CalDAV server implementations.

Note that if the AuthScheme is set to Proprietary (2) then the authorization token must be supplied through [Authorization](#Authorization) setting.

For security purposes, changing the value of this property will cause the struct to clear the values of [User](#user-property-caldav-component), [Password](#password-property-caldav-component) and [Authorization](#Authorization).

**BuildEvent**: Builds the current event for a multi-event calendar entry.Calling this setting signals the component to build the current event for a multi-event calendar entry (typically a recurring event with one or more 'exception' events).

Note: this setting is used in conjunction with [StartCalendar](#StartCalendar) and [EndCalendar](#EndCalendar).

**Created**: Date and time calendar event was created.This setting specifies the date and time that the calendar event was created 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 [GetEvent](#getevent-method-caldav-component), and is also used when creating an event to be added using the [CreateEvent](#createevent-method-caldav-component) method. However, when requesting a report using the [GetCalendarReport](#getcalendarreport-method-caldav-component) method, the contents of this property will only be valid inside the [EventDetails](#eventdetails-event-caldav-component) event.

**Depth**: The depth associated with the current operation. This setting defines how deep to operate within a collection. When performing certain operations on resource collections, the struct will use [Depth](#Depth) to instruct the server on how deep to operate within the collection. Possible values are:

|  |  |
| --- | --- |
| 0 (Unspecified - default) | Unspecified. The server will use the protocol default depth for the operation (this is normally "infinity"). |
| 1 (Resource Only) | The server will operate only on the collection resource URI, and not on any of its internal member resources. |
| 2 (Immediate Children) | The server will operate on the collection resource URI and all of its immediate member resources (but on none of their member resources). |
| 3 Infinity (Infinity) | The server will recursively operate on the target resource URI and all of its internal member URIs through all levels of the collection hierarchy. |

[Depth](#Depth) is applicable to the following methods: [LockCalendar](#lockcalendar-method-caldav-component), [MoveEvent](#moveevent-method-caldav-component), [CopyEvent](#copyevent-method-caldav-component), and [GetCalendarReport](#getcalendarreport-method-caldav-component)

**EndCalendar**: Signifies the end of a multi-event calendar entry.This setting signifies the end of a multi-event calendar entry (typically a recurring event with one or more 'exception' events). Calling this setting returns the data for the calendar, which can then be imported using the [ImportICS](#importics-method-caldav-component) method.

Note: this setting is used in conjunction with [BuildEvent](#BuildEvent) and [StartCalendar](#StartCalendar).

**ExpandRecurringEvents**: Instructs the component to return all instances of a recurring event within a timeframe.When false (default), the CalDAV server will return only a single response for each recurring event along with the recurrence rules. If this configuration option is set to true the CalDAV server will return a response for each instance of a recurring event during a given time interval. The ReportFilter.RecurStart and ReportFilter.RecurEnd fields must also be set to use this functionality. Please see the example code below:

```csharp

  calDAV.ReportFilter.StartDate = "20120130T000000Z";
  calDAV.ReportFilter.EndDate = "20120203T235959Z";
  calDAV.ReportFilter.RecurStart = calDAV.ReportFilter.StartDate;
  calDAV.ReportFilter.RecurEnd = calDAV.ReportFilter.EndDate;
  calDAV.Config("ExpandRecurringEvents=true");

  calDAV.ReportFilter.ReturnCalendarData = true;

  calDAV.ReportFilter.EventType = VEventTypes.vtAll;

  calDAV.GetCalendarReport("http://www.some-url.com/caldav.php/events");
```

**ProductId**: Specifies the identifier for the product that created the iCalendar object.The vendor of the implementation should assure that this is a globally unique identifier.

This setting should not be used to alter the interpretation of a calendar resource. For example, it is not to be used to further the understanding of non-standard properties.

This setting is required to have a value when creating a new calendar collection resource via the [CreateCalendar](#createcalendar-method-caldav-component) method. For all others it is optional.

**RecurrenceExceptionDatesAttrs**: Specifies the attributes for the exception dates of a recurring event.This setting specifies the attributes for the exception dates of a recurring event. The setting should be populated with a COMMA-separated list of one or more attributes, where each attribute is applied to the corresponding date listed in the RecurrenceExceptionDates property.

The table below shows some examples of supported values.

|  |  |
| --- | --- |
| VALUE=DATE,VALUE=DATE | Attributes for the FIRST and SECOND exception dates. |
| VALUE=DATE, | Attribute for the FIRST exception date. |
| ,VALUE=DATE | Attribute for the SECOND exception date. |

**StartCalendar**: Signifies the beginning of a multi-event calendar entry.This setting signifies the beginning of a multi-event calendar entry (typically a recurring event with one or more 'exception' events).

Note: this setting is used in conjunction with [BuildEvent](#BuildEvent) and [EndCalendar](#EndCalendar).

### WebDAV Config Settings

**EncodeURL**: If set to true the URL will be encoded by the struct.The default value of this configuration setting is False. If set to True, the URL passed to the struct will be URL encoded.

**IsDir[i]**: Whether or not the resource at the specified index is a directory.After calling ListDirectory, this configuration setting can be queried to determine whether or not the resource at index *i* is a directory (collection):

```csharp
webdav.ListDirectory("https://localhost/DAV/");
bool isDir = Convert.ToBoolean(webdav.Config("IsDir[0]"));
```

An exception will be thrown if an invalid index is specified.

**TransferredData**: Contains the contents of the last response from the server.This setting contains the contents of the last response from the server. If the LocalFile is empty, the data is accumulated in [TransferredData](#TransferredData) and also can be received in the [Transfer](#transfer-event-caldav-component) event. Otherwise, this setting returns an empty string.

**TransferredDataLimit**: The maximum amount of data to be transferred.This setting contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the [TransferredData](#TransferredData) setting.

**XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1).

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XElement**: The name of the current element.This configuration setting provides the name of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XParent**: The parent of the current element.This configuration setting provides the parent of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response.

When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#XChildXText[i]) providing other properties of the element.

XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the */* character, for example, */A/B/C/D*. An XPath can be absolute (i.e., it starts with */*), or it can be relative to the current [XPath](#XPath) location.

The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string:

| Accessor | Description |
| --- | --- |
| name | The first element with a particular name. Can be *. |
| [i] | The i-th element. |
| name[i] | The i-th element with a particular name. |
| [last()] | The last element. |
| [last()-i] | The element i before the last element. |
| name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair. Supports single and double quotes. (XML Only) |
| . | The current element. |
| .. | The parent element. |

 NOTE: XPath indices are *1-based*.

For example, assume the following XML and JSON responses.

XML:

```text
<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>
```

JSON:

```text
{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}
```

The following are examples of valid XPaths for these responses:

| Description | XML XPath | JSON XPath |
| --- | --- | --- |
| Document root | / | /json |
| Specific element | /firstlevel/one | /json/firstlevel/one |
| i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |

This list is not exhaustive, but it provides a general idea of the possibilities.

**XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements).

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XText**: The text of the current element.This configuration setting provides the inner text of the current element.

The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only.

### HTTP Config Settings

**AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the struct adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The struct only supports gzip and deflate decompression algorithms.

**AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the struct will accept compressed data. It then will uncompress the data it has received. The struct will handle data compressed by both gzip and deflate compression algorithms.

When True, the struct adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

**AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the struct will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the struct fails with an error if the server does not support HTTP/2.

The default value is True.

**Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

**Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server.

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

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

**BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-caldav-component) event, by [BytesTransferred](#BytesTransferred).

**ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

**CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

**EncodeURL**: If set to True the URL will be encoded by the struct.If set to True, the URL passed to the struct will be URL encoded. The default value is False.

**FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the struct returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new [URL](#url-property-caldav-component) for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new [URL](#url-property-caldav-component) is retrieved automatically only if the URL Scheme is the same; otherwise, the struct fails with an error.

**Note:** Following the HTTP specification, unless this option is set to 1 (Always), 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](#user-property-caldav-component) and [Password](#password-property-caldav-component) are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

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

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

Following are the valid options:

- 0 - Never
- 1 - Always
- 2 - Same Scheme

**GetOn302Redirect**: If set to True the struct will perform a GET on the new location.The default value is False. If set to True, the struct will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again.

**HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

**HTTPVersion**: The version of HTTP used by the struct.This property specifies the HTTP version used by the struct. Possible values are as follows:

- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.

**HTTP/2 Notes**

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the struct will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed.

**HTTP/3 Notes**

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

**IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:

```text
Sat, 29 Oct 2017 19:43:31 GMT.
```

**KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received.

 The default value for [KeepAlive](#KeepAlive) is *false*.

**KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

**LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-caldav-component) event. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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

**MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When [FollowRedirects](#followredirects-property-caldav-component) is set to any value other than frNever, the struct will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

**NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the struct will fall back to using "1.1" automatically. This setting will indicate which version was used.

**OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

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

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

This configuration setting is useful for extending the functionality of the struct beyond what is provided.

**ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [ProxyUser](#proxyuser-property-caldav-component) and [ProxyPassword](#proxypassword-property-caldav-component) are specified, this value is calculated using the algorithm specified by [ProxyAuthScheme](#proxyauthscheme-property-caldav-component).

**ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client.

**StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server.

**StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*.

**TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server.

**TransferredDataLimit**: The maximum number of incoming bytes to be stored by the struct.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the struct.

**TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server.

**TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

 .NET

```text
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
```

 C++

```text
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
```

**UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the struct will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the struct will not use HTTP-chunked encoding. The default value is False.

NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

**UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. In the C++ Edition for Windows, the *W version of the class must be used. For instance, *DNSW* or *HTTPW*.

**UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the struct will attempt to use the Proxy auto-config URL when establishing a connection and [ProxyAutoDetect](#proxyautodetect-property-caldav-component) is set to *True*.

When *True* (default), the struct will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

**UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

### TCPClient Config Settings

**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the struct will use [Timeout](#timeout-property-caldav-component) for establishing a connection and transmitting/receiving data.

**FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.

If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.

NOTE: This configuration setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:

|  |  |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the struct fails with an error.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the struct returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

**LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-caldav-component) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface.

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

**LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset.

If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset.

The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.

**MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

**ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

*www.google.com;www.example.com*

**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

**UseIPv6**: Whether to use IPv6.When set to *0* (default), the struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows:

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

**UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

### SSL Config Settings

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-caldav-component) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-caldav-component) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-caldav-component) is set to *Platform*.

**OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

 -----BEGIN CERTIFICATE-----

 ... (CA certificate in base64 encoding) ...

 -----END CERTIFICATE-----

 Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

**OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the struct will reuse the context if and only if the following criteria are met:

- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the struct is the same.

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-caldav-component) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the struct will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the struct will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The struct will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the struct fails with an error.

When set to 0 (default), the CRL check will not be performed by the struct. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the struct will use OCSP to check the validity of the server certificate. If set to 1 or 2, the struct will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The struct will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the struct fails with an error.

When set to 0 (default), the struct will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-caldav-component) event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the struct will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when [SSLProvider](#sslprovider-property-caldav-component) is set to *Platform* include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```

 Possible values when [SSLProvider](#sslprovider-property-caldav-component) is set to *Platform* include the following:

- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF

 Example values when [SSLProvider](#sslprovider-property-caldav-component) is set to *Internal*include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

 Possible values when [SSLProvider](#sslprovider-property-caldav-component) is set to *Internal* include the following:

- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported:

- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256

[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

|  |  |
| --- | --- |
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

**SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:**

By default when TLS 1.3 is enabled, the struct will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-caldav-component) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-caldav-component) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to *1* (Platform provider), please be aware of the following notes:

- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.
- If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

**SSLEnabledProtocols: SSL2 and SSL3 Notes: **

SSL 2.0 and 3.0 are not supported by the struct when the [SSLProvider](#sslprovider-property-caldav-component) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-caldav-component) needs to be set to platform.

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when [SSLProvider](#sslprovider-property-caldav-component) is set to *Internal*.

**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-caldav-component) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-caldav-component) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-caldav-component) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the struct will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the struct will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-caldav-component) is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |

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

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-caldav-component) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the struct will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the struct fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
```

 The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

When using TLS 1.2 and [SSLProvider](#sslprovider-property-caldav-component) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported:

- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)

**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"

**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)

 The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.

**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)

Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

-  Windows Server 2025
-  Windows 11 24H2
-  Windows 11 25H2

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-caldav-component) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([CalDAV](#caldav-component) Component)

### CalDAV Errors

|  |  |
| --- | --- |
| 222 | Property set with an improper enumeration value. |
| 234 | Missing required field. |
| 432 | Invalid array property index. |
| 471 | Server error. Description contains detailed information. |
| 476 | No lock tokens. |
| 700 | Bad response received from CalDAV server. Unable to parse. |
| 701 | The CalDAV server returned and empty calendar. |
| 702 | When creating an event containing alarms, each alarm in the event requires a Trigger. |
| 703 | Both Alarm Duration and Repeat must be specified, or neither should be specified. |
| 704 | The struct was unable to complete the requested action because a required property has not been set. |

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

### HTTP Errors

|  |  |
| --- | --- |
| 118 | Firewall error. The error description contains the detailed message. |
| 143 | Busy executing current method. |
| 151 | HTTP protocol error. The error message has the server response. |
| 152 | No server specified in [URL](#url-property-caldav-component). |
| 153 | Specified URLScheme is invalid. |
| 155 | Range operation is not supported by server. |
| 156 | Invalid cookie index (out of range). |
| 301 | Interrupted. |
| 302 | Cannot open AttachedFile. |

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

### TCPClient Errors

|  |  |
| --- | --- |
| 100 | You cannot change the RemotePort at this time. A connection is in progress. |
| 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
| 102 | The RemoteHost address is invalid (0.0.0.0). |
| 104 | Already connected. If you want to reconnect, close the current connection first. |
| 106 | You cannot change the LocalPort at this time. A connection is in progress. |
| 107 | You cannot change the [LocalHost](#localhost-property-caldav-component) at this time. A connection is in progress. |
| 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. |
| 116 | RemotePort cannot be zero. Please specify a valid service port number. |
| 117 | You cannot change the UseConnection option while the struct is active. |
| 135 | Operation would block. |
| 201 | Timeout. |
| 211 | Action impossible in control's present state. |
| 212 | Action impossible while not connected. |
| 213 | Action impossible while listening. |
| 301 | Timeout. |
| 302 | Could not open file. |
| 434 | Unable to convert string to selected CodePage. |
| 1105 | Already connecting. If you want to reconnect, close the current connection first. |
| 1117 | You need to connect first. |
| 1119 | You cannot change the LocalHost at this time. A connection is in progress. |
| 1120 | Connection dropped by remote host. |

### SSL Errors

|  |  |
| --- | --- |
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |

### TCP/IP Errors

|  |  |
| --- | --- |
| 10004 | [10004] Interrupted system call. |
| 10009 | [10009] Bad file number. |
| 10013 | [10013] Access denied. |
| 10014 | [10014] Bad address. |
| 10022 | [10022] Invalid argument. |
| 10024 | [10024] Too many open files. |
| 10035 | [10035] Operation would block. |
| 10036 | [10036] Operation now in progress. |
| 10037 | [10037] Operation already in progress. |
| 10038 | [10038] Socket operation on nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot assign requested address. |
| 10050 | [10050] Network is down. |
| 10051 | [10051] Network is unreachable. |
| 10052 | [10052] Net dropped connection or reset. |
| 10053 | [10053] Software caused connection abort. |
| 10054 | [10054] Connection reset by peer. |
| 10055 | [10055] No buffer space available. |
| 10056 | [10056] Socket is already connected. |
| 10057 | [10057] Socket is not connected. |
| 10058 | [10058] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is not empty |
| 10067 | [10067] Too many processes. |
| 10068 | [10068] Too many users. |
| 10069 | [10069] Disc Quota Exceeded. |
| 10070 | [10070] Stale NFS file handle. |
| 10071 | [10071] Too many levels of remote in path. |
| 10091 | [10091] Network subsystem is unavailable. |
| 10092 | [10092] WINSOCK DLL Version out of range. |
| 10093 | [10093] Winsock is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |