StreamUserListController class

A controller for a user list.

This class lets you perform tasks such as:

  • Load initial data.
  • Load more data using loadMore.
  • Replace the previously loaded users.
Inheritance

Constructors

StreamUserListController({required StreamChatClient client, Filter? filter, List<SortOption>? sort, bool presence = true, int limit = defaultUserPagedLimit})
Creates a Stream user list controller.
StreamUserListController.fromValue(PagedValue<int, User> value, {required StreamChatClient client, Filter? filter, List<SortOption>? sort, bool presence = true, int limit = defaultUserPagedLimit})
Creates a StreamUserListController from the passed value.

Properties

client StreamChatClient
The client to use for the channels list.
final
currentItems List<User>
Returns the currently loaded items
no setterinherited
filter Filter?
The query filters to use.
finalgetter/setter pair
hashCode int
The hash code for this object.
no setterinherited
hasListeners bool
Whether any listeners are currently registered.
no setterinherited
limit int
The limit to apply to the user list. The default is set to defaultUserPagedLimit.
final
presence bool
If true you’ll receive user presence updates via the websocket events
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sort List<SortOption>?
The sorting used for the users matching the filters.
finalgetter/setter pair
users List<User>
Replaces the previously loaded users with the passed users.
no getter
value PagedValue<int, User>
The current value stored in this notifier.
getter/setter pairinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
appendLastPage(List<User> newItems) → void
Appends newItems to the previously loaded ones and sets the next page key to null.
inherited
appendPage({required List<User> newItems, required int nextPageKey}) → void
Appends newItems to the previously loaded ones and replaces the next page's key.
inherited
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
inherited
doInitialLoad() Future<void>
Load initial data from the server.
override
loadMore(int nextPageKey) Future<void>
Load more data from the server using nextPageKey.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
refresh({bool resetValue = true}) Future<void>
Refresh the data presented by this PagedValueNotifier.
override
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
retry() Future<void>
Retry any failed load requests.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited