calendar_v1_UI Script API

Verint | Telligent Community — Wed, 14 May 2025 17:07:22 GMT

Current Revision posted to API Documentation by Verint | Telligent Community on 05/14/2025 17:07:22

Calendar Utility methods for scripted widgets

Methods

AdjustForServerTime

Velocity

#set($dateTimeResponse = $calendar_v1_UI.AdjustForServerTime($userTime))

JavaScript

var dateTimeResponse = calendar_v1_UI.AdjustForServerTime(userTime);

Parameters

Name	Type	Description	Required	Default	Options
userTime	`[[DateTime Script API Type\|DateTime]]`	User Time	Required

Returns

[[DateTime Script API Type|DateTime]]

AdjustForUserTime

Velocity

#set($dateTimeResponse = $calendar_v1_UI.AdjustForUserTime($serverTime))

JavaScript

var dateTimeResponse = calendar_v1_UI.AdjustForUserTime(serverTime);

Parameters

Name	Type	Description	Required	Default	Options
serverTime	`[[DateTime Script API Type\|DateTime]]`	Server Time	Required

Returns

[[DateTime Script API Type|DateTime]]

ApplyDateFilter

Velocity

#set($iEnumerableResponse = $calendar_v1_UI.ApplyDateFilter($filterDate, $eventsToFilter))

JavaScript

var iEnumerableResponse = calendar_v1_UI.ApplyDateFilter(filterDate, eventsToFilter);

Parameters

Name	Type	Description	Required	Default	Options
filterDate	`[[DateTime Script API Type\|DateTime]]`	Filter Date	Required
eventsToFilter	`[[IEnumerable Script API Type\|IEnumerable]] of [[Event Script API Type\|Event]]`	Events To Filter	Required

Returns

[[IEnumerable Script API Type|IEnumerable]] of [[Event Script API Type|Event]]

DaysInMonth

Velocity

#set($numberResponse = $calendar_v1_UI.DaysInMonth($year, $month))

JavaScript

var numberResponse = calendar_v1_UI.DaysInMonth(year, month);

Parameters

Name	Type	Description	Required	Default	Options
year	`[[String Script API Type\|String]]`	Year	Required
month	`[[String Script API Type\|String]]`	Month	Required

Returns

[[Number Script API Type|Number]]

GetStartDayOfWeek

Velocity

#set($numberResponse = $calendar_v1_UI.GetStartDayOfWeek($date))

JavaScript

var numberResponse = calendar_v1_UI.GetStartDayOfWeek(date);

Parameters

Name	Type	Description	Required	Default	Options
date	`[[DateTime Script API Type\|DateTime]]`	Date	Required

Returns

[[Number Script API Type|Number]]

ParseDateTimeExact

Converts a string in 'mm/dd/yyyy HH:mm:ss' format to a DateTime. Minimum Date if unparseable.

Velocity

#set($dateTimeResponse = $calendar_v1_UI.ParseDateTimeExact($date))

JavaScript

var dateTimeResponse = calendar_v1_UI.ParseDateTimeExact(date);

Parameters

Name	Type	Description	Required	Default	Options
date	`[[String Script API Type\|String]]`	Date	Required

Returns

[[DateTime Script API Type|DateTime]]

RoundUp

Velocity

#set($dateTimeResponse = $calendar_v1_UI.RoundUp($date, $interval))

JavaScript

var dateTimeResponse = calendar_v1_UI.RoundUp(date, interval);

Parameters

Name	Type	Description	Required	Default	Options
date	`[[DateTime Script API Type\|DateTime]]`	Date	Required
interval	`[[Number Script API Type\|Number]]`	Interval	Required

Returns

[[DateTime Script API Type|DateTime]]

ToCultureSafeString

Velocity

#set($stringResponse = $calendar_v1_UI.ToCultureSafeString($date))

JavaScript

var stringResponse = calendar_v1_UI.ToCultureSafeString(date);

Parameters

Name	Type	Description	Required	Default	Options
date	`[[DateTime Script API Type\|DateTime]]`	Date	Required

Returns

[[String Script API Type|String]]

ToString

Velocity

#set($stringResponse = $calendar_v1_UI.ToString())

JavaScript

var stringResponse = calendar_v1_UI.ToString();

Returns

[[String Script API Type|String]]

TranslateDayOfWeek

Velocity

#set($stringResponse = $calendar_v1_UI.TranslateDayOfWeek($weekDay, $forMini))

JavaScript

var stringResponse = calendar_v1_UI.TranslateDayOfWeek(weekDay, forMini);

Parameters

Name	Type	Description	Required	Default	Options
weekDay	`[[Number Script API Type\|Number]]`	Week Day	Required
forMini	`[[Boolean Script API Type\|Boolean]]`	For Mini	Required

Returns

[[String Script API Type|String]]