Recurrence.getOccurrence Method

Returns the occurrence with the specified index.

Namespace: MindFusion.Scheduling
File: Recurrence.js

 Syntax

JavaScript

function getOccurrence (index, refIsDeleted, noException)

 Parameters

index

Number. The index of the occurrence to retrieve.

refIsDeleted

*. If the specified occurrence is an exception, this parameter indicates, upon function completion, whether the exception is deleted or not.

noException

Boolean. Specifies whether to return the original item, in case this occurrence is an exception.

 Return Value

Item. A reference to the occurrence with the specified index or null, if there is no such occurrence.

 Remarks

This function might take considerable amount of time if you specify a large index in an infinite recurrence.