ScheduledTrigger class

A trigger which starts a task according to a recurring schedule starting on the date that the study starts.

The iCalendar RFC 5545 standard is used to specify the recurrence rule: https://tools.ietf.org/html/rfc5545#section-3.3.10

This trigger needs to be evaluated on a primary device since it is time bound and therefore requires a task scheduler.

// Every day at 8:30.
ScheduledTrigger(
  time: const TimeOfDay(hour: 8, minute: 30),
  recurrenceRule: RecurrenceRule(Frequency.DAILY),
);
Inheritance
Implemented types
Annotations
  • @JsonSerializable.new(includeIfNull: false, explicitToJson: true)

Constructors

ScheduledTrigger({String? sourceDeviceRoleName, bool? requiresPrimaryDevice = false, required TimeOfDay time, required RecurrenceRule recurrenceRule})
Create a trigger that is scheduled at time and repeats according to the recurrenceRule.
ScheduledTrigger.fromJson(Map<String, dynamic> json)
factory

Properties

$type ↔ String?
The type name written to __type in JSON; set to jsonType on creation.
getter/setter pairinherited
fromJsonFunction → Function
The generated function that converts a JSON map to an object of this type.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
jsonType → String
The __type used for JSON serialization of this class.
no setterinherited
recurrenceRule ↔ RecurrenceRule
Recurrence rule according to the iCalendar RFC 5545 standard.
getter/setter pair
requiresPrimaryDevice ↔ bool?
Determines whether the trigger needs to be evaluated on a primary device (PrimaryDeviceConfiguration). For example, this is the case when the trigger is time bound and needs to be evaluated by a task scheduler running on a primary device. Not serialized.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sourceDeviceRoleName ↔ String?
The device role name from which the trigger originates.
getter/setter pairinherited
time ↔ TimeOfDay
The time of the day to trigger.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Returns a JSON map of this object, including the __type property.
override
toString() → String
A string representation of this object.
override

Operators

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