core / io.islandtime / DayOfWeek

DayOfWeek

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) enum class DayOfWeek

A day of the week.

Enum Values

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) MONDAY
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) TUESDAY
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) WEDNESDAY
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) THURSDAY
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) FRIDAY
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) SATURDAY
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) SUNDAY

Properties

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

number

The ISO day of week number.

val number: Int

Functions

displayName	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. (jvm) `fun displayName(style: TextStyle, locale: Locale = defaultLocale()): String` (iosArm64, iosX64, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) `fun displayName(style: TextStyle, locale: <ERROR CLASS> = defaultLocale()): String`
localizedName	The localized name of the day, if available for the locale in the specified style. The result depends on the configured DateTimeTextProvider and may differ between platforms. (jvm) `fun localizedName(style: TextStyle, locale: Locale = defaultLocale()): String?` (iosArm64, iosX64, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) `fun localizedName(style: TextStyle, locale: <ERROR CLASS> = defaultLocale()): String?`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) minus	Subtracts days from this day of the week, wrapping when the beginning or end of the week is reached. `operator fun minus(days: IntDays): DayOfWeek` `operator fun minus(days: LongDays): DayOfWeek`
number	The day of week number (1-7) according to the specified locale. Typically, the week will start on either Monday, Sunday, or Saturday. The number returned may differ between platforms. (jvm) `fun number(locale: Locale): Int` (iosArm64, iosX64, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) `fun number(locale: <ERROR CLASS>): Int` The day of week number (1-7) according to the provided settings. Typically, the week will start on either Monday, Sunday, or Saturday. (iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) `fun number(settings: WeekSettings): Int`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) plus	Adds days to this day of the week, wrapping when the beginning or end of the week is reached. `operator fun plus(days: IntDays): DayOfWeek` `operator fun plus(days: LongDays): DayOfWeek`

Companion Object Properties

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) MAX	`val MAX: DayOfWeek`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) MIN	`val MIN: DayOfWeek`

Inheritors

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) FRIDAY
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) MONDAY
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) SATURDAY
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) SUNDAY
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) THURSDAY
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) TUESDAY
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) WEDNESDAY