core / io.islandtime.calendar / WeekSettings

WeekSettings

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) data class WeekSettings

Week-related calendar settings.

Constructors

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

<init>

Week-related calendar settings.

<init>(firstDayOfWeek: DayOfWeek, minimumDaysInFirstWeek: Int)

Properties

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

firstDayOfWeek

The first day of the week.

val firstDayOfWeek: DayOfWeek
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

minimumDaysInFirstWeek

The minimum number of days required in the first week of the year.

val minimumDaysInFirstWeek: Int

Companion Object Properties

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

ISO

The ISO-8601 calendar system's definition of a week, where the first day of the week is Monday and the first week of the year has a minimum of 4 days.

val ISO: WeekSettings
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

SUNDAY_START

A definition of a week that starts on Sunday with a minimum of 1 day in the first week of the year.

val SUNDAY_START: WeekSettings

Companion Object Functions

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

systemDefault

Returns the definition of a week according to the current system settings. This may differ from the definition associated with the default locale on platforms that allow this to be customized, such as iOS and macOS.

fun systemDefault(): WeekSettings