SchedulerConfig class
Configuration class for event scheduling.
This class defines how an event should be triggered and handled. It supports both time-based and count-based triggers with optional recurrence.
Required parameters:
- eventKey - Unique identifier for the event
- triggerType - Type of trigger (time or count)
- onEvent - Callback function when event is triggered
Optional parameters:
- triggerTime - Required for time-based triggers
- triggerCount - Required for count-based triggers
- recurrenceType - Type of recurrence (none, time, or count)
- recurrenceInterval - Required for time-based recurrence
- recurrenceCount - Required for count-based recurrence
- maxRecurrences - Maximum number of times event can recur
- endTime - When the event should stop recurring
- recurrenceOnEvent - Optional callback for recurrence events
- onStateUpdate - Optional callback for state changes
Constructors
- SchedulerConfig({required String eventKey, required TriggerType triggerType, int? triggerCount, DateTime? triggerTime, Duration? recurrenceInterval, int? recurrenceCount, RecurrenceType recurrenceType = RecurrenceType.none, int? maxRecurrences, DateTime? endTime, required VoidCallback onEvent, VoidCallback? recurrenceOnEvent, dynamic onStateUpdate(bool)?})
- Creates a new scheduler configuration.
Properties
- endTime → DateTime?
-
When the event should stop recurring
final
- eventKey → String
-
Unique identifier for the event
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- maxRecurrences → int?
-
Maximum number of times an event can recur
final
- onEvent → VoidCallback
-
Callback function when the event is triggered
final
- onStateUpdate → dynamic Function(bool)?
-
Optional callback for state changes
final
- recurrenceCount → int?
-
Number of times an event should recur
final
- recurrenceInterval → Duration?
-
Interval between recurring events
final
- recurrenceOnEvent → VoidCallback?
-
Optional callback for recurrence events
final
- recurrenceType → RecurrenceType
-
Type of recurrence (none, time, or count)
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- triggerCount → int?
-
Count required for count-based triggers
final
- triggerTime → DateTime?
-
Time when time-based triggers should occur
final
- triggerType → TriggerType
-
Type of trigger (time or count)
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