RecurrenceSpec class

An immutable description of a simple recurrence. Only the fields relevant to frequency are read by humanizeRecurrence; the others may stay null.

Annotations

Constructors

RecurrenceSpec(RecurrenceFrequency frequency, {int interval = 1, int? weekday, int? weekOfMonth, int? monthDay, int? month})
Creates a spec. interval is the "every N" multiplier (default 1) and must be >= 1 — a zero or negative interval has no meaning ("every 0 days").
const

Properties

frequency RecurrenceFrequency
The repeat unit (daily/weekly/monthly/yearly).
final
hashCode int
The hash code for this object.
no setterinherited
interval int
The "every N" multiplier; 1 means every single unit.
final
month int?
Month (1..12) for yearly recurrences, or null.
final
monthDay int?
Day of month (1..31) for monthly-by-date or yearly recurrences, or null.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
weekday int?
Weekday for weekly / nth-weekday recurrences (1 = Monday .. 7 = Sunday), or null when the recurrence has no weekday component.
final
weekOfMonth int?
Which occurrence of weekday within the month (1..5 for "2nd Tuesday"), or null for a plain weekly recurrence.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited