RunPeriodically class
Runs the given callback repeatedly after each given interval period.
When the widget is first initialized, the callback can either be run after
the specified interval (default) or immediately if runImmediately is
set to true. The callback will then run again periodically after the
given interval.
This widget is declarative; if the widget updates and the interval changes, it will run the callback based on the new interval, even calling instantly if the interval is shorter.
A null duration will result in no callbacks.
This widget also respects the app's lifecycle and will not invoke the callback while the app is paused.
If the callback throws, this widget will retry calling the callback again after a backoff period (errorBackoffSeconds) that increases exponentially.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- RunPeriodically
Constructors
- RunPeriodically({Key? key, Duration? interval = const Duration(seconds: 2), bool runImmediately = false, required VoidCallback callback, required Widget child})
-
const
Properties
- callback → VoidCallback
-
final
- child → Widget
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- interval → Duration?
-
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- runImmediately → bool
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< RunPeriodically> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited