RecurrenceRule class

An immutable, parsed RRULE. Construct directly or via parseRrule. Defaults mirror RFC 5545: interval 1, weekStart Monday, all by* lists empty.

Annotations

• @immutable

Constructors

RecurrenceRule({required RecurFrequency frequency, int interval = 1, int? count, DateTime? until, List<RecurWeekday> byWeekDays = const <RecurWeekday>[], List<int> byMonthDays = const <int>[], List<int> byMonths = const <int>[], RecurWeekday weekStart = RecurWeekday.monday})

Creates a rule. Only frequency is required. Audited: 2026-06-12 11:26 EDT

const

Properties

byMonthDays → List<int>

Restrict to these days of the month (1..31, or negative from month end).

final

byMonths → List<int>

Restrict to these months (1..12), chiefly for YEARLY.

final

byWeekDays → List<RecurWeekday>

Restrict to these weekdays (chiefly for WEEKLY); empty means no filter.

final

count → int?

Stop after this many occurrences, or null for unbounded / until-bounded.

final

frequency → RecurFrequency

The base repeat unit (daily/weekly/monthly/yearly).

final

hashCode → int

The hash code for this object.

no setter, override

interval → int

Repeat every N units (≥ 1).

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

until → DateTime?

Stop on/after this instant (inclusive), or null. Mutually informative with count; a rule may set neither (truly unbounded), either, or both.

final

weekStart → RecurWeekday

First day of the week (affects weekly interval math); defaults to Monday.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override