AsyncTaskBuilder<T> class
A widget that allow to run an async task and handle all states (loading, errors, onSuccess).
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- AsyncTaskBuilder
Constructors
-
AsyncTaskBuilder({Key? key, FetcherConfig? config, Color? barrierColor, bool runTaskOnStart = false, AsyncValueGetter<
T> ? task, required AsyncTaskChildBuilder<T> builder, AsyncValueSetter<T> ? onSuccess}) -
const
Properties
- barrierColor → Color?
-
Color of the barrier, displayed when running the task.
Default to a translucent white.
Use Colors.transparent to hide completely the barrier (still blocks interactions).
final
-
builder
→ AsyncTaskChildBuilder<
T> -
Widget builder, that provides a runTask callback.
You may pass a task to run, that will override widget's task.
final
- config → FetcherConfig?
-
Widget configuration, that will override the one provided by DefaultFetcherConfig
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onSuccess
→ AsyncValueSetter<
T> ? -
Called after task is successfully executed.
final
- runTaskOnStart → bool
-
Whether to run the task on start.
Default to false.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
task
→ AsyncValueGetter<
T> ? -
Task to be executed.
Will be overridden by task passed when calling runTask provided by builder.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< AsyncTaskBuilder< T> > -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNodeobjects 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
Static Methods
-
runTask<
T> ({required BuildContext context, required AsyncValueGetter< T> task, FetcherConfig? config, AsyncValueSetter<T> ? onSuccess}) → Future<void> - Safely run a async task. Headless version of AsyncTaskBuilder.