report_filter_return_calendar_data Property

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

Syntax

def get_report_filter_return_calendar_data() -> bool: ...
def set_report_filter_return_calendar_data(value: bool) -> None: ...

report_filter_return_calendar_data = property(get_report_filter_return_calendar_data, set_report_filter_return_calendar_data)

Default Value

TRUE

Remarks

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

If report_filter_return_calendar_data 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 report_filter_return_calendar_data 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 report_filter_recur_start and report_filter_recur_end properties.