Skip to content

//core/io.islandtime/DayOfWeek/SATURDAY

SATURDAY

common

SATURDAY

Properties

Name Summary
name

common


val name: String
number

common


val number: Int

The ISO day of week number.
ordinal

common


val ordinal: Int

Functions

Name Summary
displayName

common


fun displayName(style: TextStyle, locale: Locale): 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.
localizedName

common


fun localizedName(style: TextStyle, locale: Locale): String?

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.
minus

common


operator fun minus(days: Days): DayOfWeek

Returns this day of the week with days subtracted from it, wrapping when the beginning or end of the week is reached.
number

common


fun number(settings: WeekSettings): Int

The day of week number (1-7) according to the provided settings. Typically, the week will start on either Monday, Sunday, or Saturday.

common


fun number(locale: Locale): Int

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.
plus

common


operator fun plus(days: Days): DayOfWeek

Returns this day of the week with days added to it, wrapping when the beginning or end of the week is reached.