core / io.islandtime / TimeZone / Region

Region

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) class Region : TimeZone

A named time zone, typically corresponding to a region identifier in the IANA Time Zone Database, but may be any name that can be understood by a TimeZoneRulesProvider.

Parameters

id - an ID that is understood by a time zone rules provider

Properties

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

id

an ID that is understood by a time zone rules provider

val id: String
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

isValid

Checks if this is a valid time zone according to the current time zone rules provider.

val isValid: Boolean
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

rules

The rules associated with this time zone.

val rules: TimeZoneRules

Functions

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

equals

fun equals(other: Any?): Boolean
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

hashCode

fun hashCode(): Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

normalized

Returns a normalized time zone, converting any zone with a fixed offset to use a consistent identifier.

fun normalized(): TimeZone

Inherited Functions

(jvm)

displayName

A textual representation of this time zone, suitable for display purposes. The localized name will be returned, if available for the locale in the specified style. If not, the id will be returned instead.

fun displayName(style: TimeZoneTextStyle, locale: Locale = defaultLocale()): String
(jvm)

localizedName

The localized name of this time zone, if available for the locale in the specified style. The result depends on the configured TimeZoneTextProvider and may differ between platforms.

fun localizedName(style: TimeZoneTextStyle, locale: Locale = defaultLocale()): String?