LiveStreamListener<B extends LiveStream, S> class

Takes a StreamWidgetListener and an optional liveStream and SyncLiveStream invokes the listener in response to state changes in the SyncLiveStream. It should be used for functionality that needs to occur only in response to a state change such as navigation, showing a SnackBar, showing a Dialog, etc... The listener is guaranteed to only be called once for each state change unlike the builder in LiveStreamBuilder.

If the SyncLiveStream parameter is omitted, LiveStreamListener

LiveStreamListener(
  listener: (context, state) {
    // do stuff here based on LiveStream's state
  },
  child: Container(),
)

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

LiveStreamListener(
  liveStream: LiveStreamA,
  listener: (context, state) {
    // do stuff here based on LiveStreamA's state
  },
  propertyKey : key
  child: Container(),
)
Inheritance

Constructors

LiveStreamListener({Key? key, required StreamWidgetListener listener, B? liveStream, Widget? child, required Object propertyKey})
const

Properties

child → Widget?
The widget which will be rendered as a descendant of the LiveStreamListenerBase.
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 → StreamWidgetListener
The LiveStreamWidgetListener which will be called on every state change. This listener should be used for any code which needs to execute in response to a state change.
finalinherited
liveStream → B?
The liveStream whose state will be listened to. Whenever the stream's state changes, listener will be invoked.
finalinherited
propertyKey → Object
The propertyKey will be mapping properties.
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<LiveStreamListenerBase<B, S>>
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