lib/com.maltaisn.recurpicker/Recurrence/Builder

Builder

Builder for recurrence.

Constructors

constructor(period: Recurrence.Period)

Create a builder initialized for a recurrence with a period.

constructor(recurrence: Recurrence)

Create a builder initialized with the values of another recurrence.

Properties

var dayInMonth: Int

If period is MONTHLY, set the day in the month on which events happen.

var endCount: Int

Setting this value will changing end type to by count. Must be at least 1. If less than 1, the period will be set to Period.NONE.

var endDate: Long

Setting this value will changing end type to by date. If end date is DATE_NONE, recurrence end type will be set to never.

var endType: Recurrence.EndType

This field doesn't have to be set directly most of the time, since setting the end date or end count will set it automatically.

var frequency: Int

Frequency must be at least 1.

var period: Recurrence.Period

Functions

fun build(): Recurrence

Build the recurrence object described by the builder. This validates and normalizes all field values.

fun setDayInMonth(dayInMonth: Int): Recurrence.Builder

setDayOfWeekInMonth

fun setDayOfWeekInMonth(day: Int, week: Int): Recurrence.Builder

If period is MONTHLY, set byDay setting so that the recurrence happens on a day of a week in the month. If both parameters are 0, the week number and day of the week will be the same as start date's.

fun setDaysOfWeek(vararg days: Int): Recurrence.Builder

If period is WEEKLY, set byDay field to a list of days of the week.

fun setEndCount(endCount: Int): Recurrence.Builder

fun setEndDate(endDate: Long): Recurrence.Builder

fun setEndType(endType: Recurrence.EndType): Recurrence.Builder

fun setFrequency(frequency: Int): Recurrence.Builder