core / io.islandtime / DayOfWeek / displayName

displayName

(iosArm64, iosX64, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) fun displayName(style: TextStyle, locale: <ERROR CLASS> = defaultLocale()): String

A textual representation of the day, suitable for display purposes. The localized name will be returned, if available. If not, the ISO day of week number will be returned instead.

The result depends on the configured DateTimeTextProvider and may differ between platforms.

Parameters

style - the style of text

locale - the locale

Return
the localized name or number if unavailable for the specified locale

See Also

localizedName

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