ConnectionListener class
ConnectionListener is responsible for performing a one-time action based on the Connection state change.
It should be used for functionality that needs to occur only once in response to the Connection state change such as navigation, showing a SnackBar, showing a Dialog, etc.
ConnectionListener is a wrapper over the BlocListener
widget so it
accepts a bloc
object as well as a child
widget.
It also takes ConnectionCallback functions for possible states:
onOnline
- a callback for the the Connection.online state,
onOffline
- a callback for the Connection.offline state.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- SingleChildStatefulWidget
- ConnectionListener
- Implemented types
Constructors
- ConnectionListener({Key? key, ConnectionBloc? bloc, Widget? child, ConnectionCallback? onOnline, ConnectionCallback? onOffline})
Properties
- bloc → ConnectionBloc?
-
The
bloc
whosestate
will be listened to. Whenever thebloc
'sstate
changes,listener
will be invoked.finalinherited - child → Widget?
-
The widget which will be rendered as a descendant of the
BlocListenerBase
.finalinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
listener
→ BlocWidgetListener<
Connection> -
The
BlocWidgetListener
which will be called on everystate
change. Thislistener
should be used for any code which needs to execute in response to astate
change.finalinherited -
listenWhen
→ BlocListenerCondition<
Connection> ? -
An optional listenWhen can be implemented for more granular control
over when listener is called.
listenWhen will be invoked on each
bloc
state
change. listenWhen takes the previousstate
and currentstate
and must return a bool which determines whether or not the listener function will be invoked. The previousstate
will be initialized to thestate
of thebloc
when theBlocListener
is initialized. listenWhen is optional and if omitted, it will default totrue
.finalinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → SingleChildStatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → SingleChildState< BlocListenerBase< ConnectionBloc, Connection> > -
Creates the mutable state for this widget at a given location in the tree.
inherited
-
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, int wrapWidth = 65}) → 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