This function checks whether, a given timestamp (e.g. the due date of an issue) falls into a time frame defined in a JWT calendar specification.


withinCalendar(timestamp, calendarName, timeZone) #Output: Boolean


Parser expressionDescription


withinCalendar(2020/12/01 8:00, "my_calendar", LOCAL)


This example returns: 

true

December 1st of 2020 is a Tuesday.



withinCalendar(2020/12/01 17:00, "my_calendar", LOCAL)


This example returns: 

false

December 1st of 2020 is a Tuesday.




Parameters used in this function

ParameterInput (data type)Description
timestamp

The parameter must be valid timestamp. Usually this value is retrieved from a field (e.g. due date, created date).
calendarName

The name of the used JWT calendar.
timeZone

The time zone used for the calculation.



This function returns a




Variant of the function where you can define an additional JWT calendar specification.


withinCalendar(timestamp, calendarName, additionalSpecifier, timeZone) #Output: Boolean


Parser expressionDescription


withinCalendar(2020/12/04 9:00, "my_calendar", "2020/12/04 {;}", LOCAL)


This example returns: 

false


The additional specifier {;} excludes December 4th from the calendar.




Parameters used in this function:

ParameterInput(data type)Description
timestamp

The parameter must be valid timestamp. Usually this value is retrieved from a field (e.g. due date, created date).
calendarName

The name of the used JWT calendar.
additionalSpecifier

A text containing an additional JWT calendar specification
timeZone

The time zone used for the calculation.



This function returns a


This function is usually used in a validators or the conditional execution parameter of post functions.



Use cases and examples




Status
Tech review

Style guide




Short descriptionChecks whether a timestamp falls into a time frame defined in a JWT calendar specification.
Output

Available since

Label