EventDetails Event

Fires for each calendar event received.

Syntax

caldav.on('EventDetails', [callback])

Callback

The 'callback' is called when the 'EventDetails' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.resourceURI
e.responseStatus
e.ETag
e.calendarData

Remarks

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

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

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

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