RecurrenceRule class - rrule library

Constructors

RecurrenceRule({required Frequency frequency, DateTime? until, int? count, int? interval, List<int> bySeconds = const [], List<int> byMinutes = const [], List<int> byHours = const [], List<ByWeekDayEntry> byWeekDays = const [], List<int> byMonthDays = const [], List<int> byYearDays = const [], List<int> byWeeks = const [], List<int> byMonths = const [], List<int> bySetPositions = const [], int? weekStart, bool shouldCacheResults = false})
RecurrenceRule.fromJson(Map<String, dynamic> json): factory
RecurrenceRule.fromString(String input, {RecurrenceRuleFromStringOptions options = const RecurrenceRuleFromStringOptions()}): factory

Properties

actualInterval → int: Returns interval or 1 if that is not set.
no setter
actualWeekStart → int: Returns weekStart or DateTime.monday if that is not set.
no setter
byHours → List<int>: Corresponds to the BYHOUR property.
final
byMinutes → List<int>: Corresponds to the BYMINUTE property.
final
byMonthDays → List<int>: Corresponds to the BYMONTHDAY property.
final
byMonths → List<int>: Corresponds to the BYMONTH property.
final
bySeconds → List<int>: Corresponds to the BYSECOND property.
final
bySetPositions → List<int>: Corresponds to the BYSETPOS property.
final
byWeekDays → List<ByWeekDayEntry>: Corresponds to the BYDAY property.
final
byWeeks → List<int>: Corresponds to the BYWEEKNO property.
final
byYearDays → List<int>: Corresponds to the BYYEARDAY property.
final
cache → Cache: no setter
canFullyConvertToText → bool: Whether this rule can be converted to a human-readable string.
no setter
count → int?: Corresponds to the COUNT property.
final
frequency → Frequency: Corresponds to the FREQ property.
final
hasByHours → bool: no setter
hasByMinutes → bool: no setter
hasByMonthDays → bool: no setter
hasByMonths → bool: no setter
hasBySeconds → bool: no setter
hasBySetPositions → bool: no setter
hasByWeekDays → bool: no setter
hasByWeeks → bool: no setter
hasByYearDays → bool: no setter
hashCode → int: The hash code for this object.
no setteroverride
interval → int?: Corresponds to the INTERVAL property.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
shouldCacheResults → bool: final
until → DateTime?: (Inclusive)
final
weekStart → int?: Corresponds to the WKST property.
final

Methods

copyWith({Frequency? frequency, DateTime? until, bool clearUntil = false, int? count, bool clearCount = false, int? interval, bool clearInterval = false, List<int>? bySeconds, List<int>? byMinutes, List<int>? byHours, List<ByWeekDayEntry>? byWeekDays, List<int>? byMonthDays, List<int>? byYearDays, List<int>? byWeeks, List<int>? byMonths, List<int>? bySetPositions}) → RecurrenceRule
getAllInstances({required DateTime start, DateTime? after, bool includeAfter = false, DateTime? before, bool includeBefore = false}) → List<DateTime>
getInstances({required DateTime start, DateTime? after, bool includeAfter = false, DateTime? before, bool includeBefore = false}) → Iterable<DateTime>
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toJson({RecurrenceRuleToJsonOptions options = const RecurrenceRuleToJsonOptions()}) → Map<String, dynamic>: Converts this rule to a machine-readable, RFC-7265-compliant string.
toString({RecurrenceRuleToStringOptions options = const RecurrenceRuleToStringOptions()}) → String: Converts this rule to a machine-readable, RFC-5545-compliant string.
override
toText({required RruleL10n l10n}) → String: Converts this rule to a human-readable string.

Operators

operator ==(Object other) → bool: The equality operator.
override