ChannelsBloc class Null safety

Widget dedicated to the management of a channel list with pagination ChannelsBloc is used together with ChannelListCore to manage a list of Channels with pagination, re-ordering, querying and other operations associated with Channels.

ChannelsBloc can be access at anytime by using the static of method using Flutter's BuildContext.

API docs: https://getstream.io/chat/docs/flutter-dart/query_channels/

Inheritance

Constructors

ChannelsBloc({Key? key, required Widget child, bool lockChannelsOrder = false, Comparator<Channel>? channelsComparator, bool shouldAddChannel(Event)?})
Creates a new ChannelsBloc. The parameter child must be supplied and not null.
const

Properties

channelsComparator Comparator<Channel>?
Comparator used to sort the channels when a message.new event is received
final
child Widget
The widget child
final
hashCode int
The hash code for this object. [...]
@nonVirtual, read-only, inherited
key Key?
Controls how one widget replaces another widget in the tree. [...]
final, inherited
lockChannelsOrder bool
Set this to true to prevent channels to be brought to the top of the list when a new message arrives
final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
shouldAddChannel → (bool Function?(Event)?)
Function used to evaluate if a channel should be added to the list when a message.new event is received
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree. [...]
inherited
createState() ChannelsBlocState
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. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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. [...]
@nonVirtual, inherited

Static Methods

of(BuildContext context) ChannelsBlocState
Use this method to get the current ChannelsBlocState instance