ReportFilterRecurStart Property

Limits the recurring events returned in the report.

Syntax

 caldav.getReportFilterRecurStart([callback])
 caldav.setReportFilterRecurStart( reportFilterRecurStart, [callback])

Default Value

""

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 getReportFilterRecurStart([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 setReportFilterRecurStart([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

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 and ReportFilterRecurEnd or that affect other instances that overlap the time range specified by ReportFilterStartDate and ReportFilterEndDate. 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 property cannot be used when ReportFilterReturnCalendarData is False.

Data Type

String