app.IValueFactory.createZonedDateTime() method

Home > @i2analyze/notebook-sdk > app > IValueFactory > createZonedDateTime

app.IValueFactory.createZonedDateTime() method

Creates a date-time object that has a time zone from an ISO 8601 string ('yyyy-mm-ddThh:mm:ss' or 'yyyy-mm-ddThh:mm:ss.sss') and a time zone.

Signature:

createZonedDateTime(iso8601: string, timeZone: data.ITimeZone | data.TimeZoneId, isDst: boolean): data.IZonedDateTime;

Introduced: version 1.1

Parameters

Parameter Type Description

iso8601 string An ISO 8601-formatted string that represents the date and time.

timeZone data.ITimeZone | data.TimeZoneId A time zone, or a time zone identifier.

isDst

boolean

Parameter	Type	Description
iso8601	string	An ISO 8601-formatted string that represents the date and time.
timeZone	data.ITimeZone \| data.TimeZoneId	A time zone, or a time zone identifier.
isDst	boolean	`true` if the date-time is in daylight saving time for the specified time zone; `false` otherwise. This value is especially important for date-time values that are ambiguous, such as during the period when clocks go back from DST to not-DST and the same local time occurs twice.

true if the date-time is in daylight saving time for the specified time zone; false otherwise.

This value is especially important for date-time values that are ambiguous, such as during the period when clocks go back from DST to not-DST and the same local time occurs twice.

Returns:

data.IZonedDateTime

The new date-time object.

Exceptions

Error if the string was not in valid ISO 8601 format, or timeZone did not specify a valid time zone.