StreamChannelListController constructor
StreamChannelListController({
- required StreamChatClient client,
- StreamChannelListEventHandler? eventHandler,
- Filter? filter,
- @Deprecated('''
sort has been deprecated.
Please use channelStateSort instead.''') List<
SortOption< ? sort,ChannelModel> > - List<
SortOption< ? channelStateSort,ChannelState> > - bool presence = true,
- int limit = defaultChannelPagedLimit,
- int? messageLimit,
- int? memberLimit,
Creates a Stream channel list controller.
-
client
is the Stream chat client to use for the channels list. -
channelEventHandlers
is the channel events to use for the channels list. This class can be mixed in or extended to create custom overrides. See StreamChannelListEventHandler for advice. -
filter
is the query filters to use. -
sort
is the sorting used for the channels matching the filters. -
presence
sets whether you'll receive user presence updates via the websocket events. -
limit
is the limit to apply to the channel list. -
messageLimit
is the number of messages to fetch in each channel. -
memberLimit
is the number of members to fetch in each channel.
Implementation
StreamChannelListController({
required this.client,
StreamChannelListEventHandler? eventHandler,
this.filter,
@Deprecated('''
sort has been deprecated.
Please use channelStateSort instead.''') this.sort,
this.channelStateSort,
this.presence = true,
this.limit = defaultChannelPagedLimit,
this.messageLimit,
this.memberLimit,
}) : _eventHandler = eventHandler ?? StreamChannelListEventHandler(),
super(const PagedValue.loading());