StreamChannel class
Widget used to provide information about the channel to the widget tree
Use StreamChannel.of to get the current StreamChannelState instance.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- StreamChannel
Constructors
- StreamChannel({Key? key, required Widget child, required Channel channel, bool showLoading = true, String? initialMessageId, ErrorWidgetBuilder errorBuilder = _defaultErrorBuilder, WidgetBuilder loadingBuilder = _defaultLoadingBuilder})
-
Creates a new instance of StreamChannel. Both child and channel must
be supplied and not null.
const
Properties
- channel → Channel
-
channel specifies the channel with which child should be wrapped
final
- child → Widget
-
The child of the widget
final
- errorBuilder → ErrorWidgetBuilder
-
Widget builder used in case an error occurs while building the channel.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- initialMessageId → String?
-
If passed the channel will load from this particular message.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- loadingBuilder → WidgetBuilder
-
Widget builder used in case the channel is initialising.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showLoading → bool
-
Shows a loading indicator
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → StreamChannelState -
Creates the mutable state for this widget at a given location in the tree.
override
-
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
Static Methods
-
of(
BuildContext context) → StreamChannelState - Use this method to get the current StreamChannelState instance