BlocSideEffectListener<B extends SideEffectProvider<C>, C> class

Takes a BlocWidgetSideEffectListener and an optional bloc and invokes the listener in response to side effect emits in the bloc. It should be used for functionality that needs to occur only in response to a side effect emit such as navigation, showing a SnackBar, showing a Dialog, etc... The listener is guaranteed to only be called once for each side effect.

If the bloc parameter is omitted, BlocListener will automatically perform a lookup using BlocProvider and the current BuildContext.

BlocSideEffectListener<BlocA, BlocASideEffect>(
  listener: (context, sideEffect) {
    // do stuff here based on BlocA's side effect
  },
  child: Container(),
)

Only specify the bloc if you wish to provide a bloc that is otherwise not accessible via BlocProvider and the current BuildContext.

BlocSideEffectListener<BlocA, BlocASideEffect>(
  value: blocA,
  listener: (context, sideEffect) {
    // do stuff here based on BlocA's side effect
  },
  child: Container(),
)
Inheritance
Implemented types
Mixed-in types

Constructors

BlocSideEffectListener({Key? key, required BlocWidgetSideEffectListener<C> listener, B? bloc, Widget? child})
Takes a BlocWidgetSideEffectListener and an optional bloc and invokes the listener in response to side effect emits in the bloc. It should be used for functionality that needs to occur only in response to a side effect emit such as navigation, showing a SnackBar, showing a Dialog, etc... The listener is guaranteed to only be called once for each side effect.
const

Properties

bloc → B?
The bloc whose side effect will be listened to. Whenever the bloc's side effect emits, listener will be invoked.
finalinherited
child → Widget?
The widget which will be rendered as a descendant of the BlocSideEffectListenerBase.
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 → BlocWidgetSideEffectListener<C>
The BlocWidgetListener which will be called on every side effect emit. This listener should be used for any code which needs to execute in response to a side effect emit.
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<BlocSideEffectListenerBase<B, C>>
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}) → 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