RecurrenceRule class

Represents the iCalendar RFC 5545 standard recurrence rule to specify repeating events: https://tools.ietf.org/html/rfc5545#section-3.3.10

However, since date times are relative to the start time of a study, they are replaced with time spans representing elapsed time since the start of the study.

Annotations
  • @JsonSerializable(includeIfNull: false, explicitToJson: true)

Constructors

RecurrenceRule(Frequency frequency, {int interval = 1, End? end})
RecurrenceRule.fromJson(Map<String, dynamic> json)
factory
RecurrenceRule.fromString(String rrule)
Initialize a RecurrenceRule based on a rrule string.
factory

Properties

end ↔ End
Specifies when, if ever, to stop repeating events. Default recurrence is forever.
getter/setter pair
frequency → Frequency
Specifies the type of interval at which to repeat events, or multiples thereof.
final
hashCode → int
The hash code for this object.
no setterinherited
interval ↔ int
The interval at which frequency repeats. The default is 1. For example, with Frequency.DAILY, a value of "8" means every eight days.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A valid RFC 5545 string representation of this recurrence rule, except when end is specified as End.Until. When End.Until is specified, 'UNTIL' holds the total number of microseconds which need to be added to a desired start date. 'UNTIL' should be reassigned to a calculated end date time, formatted using the RFC 5545 specifications: https://tools.ietf.org/html/rfc5545#section-3.3.5
override

Operators

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