ServiceBlocListener<Bloc extends ServiceBloc<ServiceRequestedEvent, ResponseData> , ServiceRequestedEvent extends ServiceRequested, ResponseData> class
ServiceBlocListener handles callback in response to relative state.
If parameter listenWhen
is omitted, default listenWhen
will only return
true when certain parameter is set. For example onInitial onLoading
onResponded onSucceed
onFailure.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- SingleChildStatefulWidget
- ServiceBlocListener
- Implemented types
Constructors
-
ServiceBlocListener.new({Key? key, Bloc? bloc, BlocListenerCondition<
ServiceState> ? listenWhen, dynamic onInitial(BuildContext context, ServiceInitial state)?, dynamic onLoading(BuildContext context, ServiceLoadInProgress<ServiceRequestedEvent> state, ServiceRequestedEvent event)?, dynamic onResponded(BuildContext context, ServiceResponseState<ServiceRequestedEvent> state, ServiceRequestedEvent event)?, dynamic onSuccess(BuildContext context, ServiceLoadSuccess<ServiceRequestedEvent, ResponseData> state, ServiceRequestedEvent event, ResponseData data)?, dynamic onFailure(BuildContext context, ServiceLoadFailure<ServiceRequestedEvent> state, ServiceRequestedEvent event, dynamic error)?, Widget? child}) - A constructor for creating a ServiceBlocListener with predefined state callback.
Properties
- bloc → Bloc?
-
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<
ServiceState> -
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<
ServiceState> ? -
An optional
listenWhen
can be implemented for more granular control over when listener is called.listenWhen
will be invoked on each blocstate
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 the bloc when theBlocListener
is initialized.listenWhen
is optional and if omitted, it will default totrue
.finalinherited -
onFailure
→ dynamic Function(BuildContext context, ServiceLoadFailure<
ServiceRequestedEvent> state, ServiceRequestedEvent event, dynamic error)? -
A function which is only called when
listenWhen
is omitted or customlistenWhen
is passed and onFailure is not omitted and current state is ServiceLoadFailure.final - onInitial → dynamic Function(BuildContext context, ServiceInitial state)?
-
A function which is only called when
listenWhen
is omitted or customlistenWhen
is passed, onInitial is not omitted and current state is ServiceInitial.final -
onLoading
→ dynamic Function(BuildContext context, ServiceLoadInProgress<
ServiceRequestedEvent> state, ServiceRequestedEvent event)? -
A function which is only called when
listenWhen
is omitted or customlistenWhen
is passed, onLoading is not omitted and current state is ServiceLoadInProgress.final -
onResponded
→ dynamic Function(BuildContext context, ServiceResponseState<
ServiceRequestedEvent> state, ServiceRequestedEvent event)? -
A function which is only called when
listenWhen
is omitted or customlistenWhen
is passed and onResponded is not omitted and current state is ServiceResponseState.final -
onSuccess
→ dynamic Function(BuildContext context, ServiceLoadSuccess<
ServiceRequestedEvent, ResponseData> state, ServiceRequestedEvent event, ResponseData data)? -
A function which is only called when
listenWhen
is omitted or customlistenWhen
is passed andonSucceed
is not omitted and current state is ServiceLoadSuccess.final - 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< Bloc, ServiceState> > -
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