Recurrence class
This value type is used to identify properties that contain a recurrence rule specification.
Constructors
-
Recurrence(RecurrenceFrequency frequency, {DateTime? until, int? count, int? interval, List<
int> ? bySecond, List<int> ? byMinute, List<int> ? byHour, List<ByDayRule> ? byWeekDay, List<int> ? byYearDay, List<int> ? byWeek, List<int> ? byMonth, List<int> ? byMonthDay, int? startOfWorkWeek, List<int> ? bySetPos}) -
Creates a new Recurrence rule with the specified frequency and
other optional settings.
const
Properties
-
byHour
→ List<
int> ? -
BYHOUR
modifier / limiter for this Recurrence.final -
byMinute
→ List<
int> ? -
BYMINUTE
modifier / limiter for this Recurrence.final -
byMonth
→ List<
int> ? -
BYMONTH
modifier / limiter for this Recurrence.final -
byMonthDay
→ List<
int> ? -
BYMONTHDAY
modifier / limiter for this Recurrence.final -
bySecond
→ List<
int> ? -
Seconds modifier / limiter for this Recurrence.
final
-
bySetPos
→ List<
int> ? -
BYSETPOS modifier / limiter for this Recurrence.
final
-
byWeek
→ List<
int> ? -
BYWEEKNO
modifier / limiter for this Recurrence.final -
byWeekDay
→ List<
ByDayRule> ? -
BYDAY
modifier / limiter for this Recurrence.final -
byYearDay
→ List<
int> ? -
BYYEARDAY
modifier / limiter for this Recurrence.final - count → int?
-
The
COUNT
rule part defines the number of occurrences at which to range-bound the recurrence.final - frequency → RecurrenceFrequency
-
The
FREQ
rule part identifies the type of recurrence rule.final - hasByHour → bool
-
Checks if there is at least one byHour modifier
no setter
- hasByLimiter → bool
-
Checks if this recurrence rule has any
BY-XXX
limiter/specifier.no setter - hasByMinute → bool
-
Checks if there is at least one byMinute modifier
no setter
- hasByMonth → bool
-
Checks if this rule has at least one byMonth modifier
no setter
- hasByMonthDay → bool
-
Checks if this rule has at least one byYearDay modifier
no setter
- hasBySecond → bool
-
Checks if there is at least one bySecond modifier
no setter
- hasBySetPos → bool
-
Checks if this rule has
BYSETPOS
rulesno setter - hasByWeek → bool
-
Checks if this rule has at least one byWeek modifier
no setter
- hasByWeekDay → bool
-
Checks if there is at least one byWeekDay modifier
no setter
- hasByWeekDayWithWeeks → bool
-
Checks if there is at least one by week day modifier with a
weeks number set.
no setter
- hasByYearDay → bool
-
Checks if this rule has at least one byYearDay modifier
no setter
- hashCode → int
-
The hash code for this object.
no setteroverride
- hasLimit → bool
-
Checks if this recurrence rule is limited,
either by count or by until.
no setter
- interval → int
-
The
INTERVAL
rule part contains a positive integer representing at which intervals the recurrence rule repeats.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- startOfWorkWeek → int
-
The
WKST
rule part specifies the day on which the workweek starts, defaults to DateTime.monday.no setter - until → DateTime?
-
The
UNTIL
rule part defines a DATE or DATE-TIME value that bounds the recurrence rule in an inclusive manner.final
Methods
-
copyWith(
{RecurrenceFrequency? frequency, DateTime? until, int? count, int? interval, List< int> ? bySecond, List<int> ? byMinute, List<int> ? byHour, List<ByDayRule> ? byWeekDay, List<int> ? byYearDay, List<int> ? byWeek, List<int> ? byMonth, List<int> ? byMonthDay, int? startOfWorkWeek, List<int> ? bySetPos, bool copyByRules = true, bool copyUntil = true}) → Recurrence - Copies this recurrence rule with the given attributes.
-
copyWithout(
RecurrenceAttribute attribute) → Recurrence -
Copies this recurrence rule without the specified
attribute
. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toHumanReadableText(
{DateTime? startDate, RruleL10n? localization, SupportedLanguage? language, String? languageCode}) → String - Tries to convert this recurrence rule to human readable text
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override
Static Methods
-
parse(
String content) → Recurrence -
Parses the Recurrence role from the given
content
.