ReportFilterReturnCalendarData Property
Controls whether the contents of each calendar event is returned in the report.
Syntax
caldavs.getReportFilterReturnCalendarData([callback]) caldavs.setReportFilterReturnCalendarData( reportFilterReturnCalendarData, [callback])
Default Value
TRUE
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getReportFilterReturnCalendarData([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setReportFilterReturnCalendarData([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
Controls whether the contents of each calendar event is returned in the report.
If ReportFilterReturnCalendarData is True (default), a report will contain the full contents of each event in the calendar. This can be a substantially large amount of data. However if ReportFilterReturnCalendarData is False, the report returned will contain only URIs and ETags of each calendar event. You may compare the URIs against a cached list and retrieve any new URIs individually via the CalDAV.GetCalendarEvent method. If the ETag for a cached URI has changed, it means that the calendar event has changed, and needs to be retrieved.
Note that this filter is not compatible with the ReportFilterRecurStart and ReportFilterRecurEnd properties.
Data Type
Boolean