StreamMemberListController class
A controller for a member list.
This class lets you perform tasks such as:
- Load initial data.
- Load more data using loadMore.
- Replace the previously loaded members.
- Inheritance
-
- Object
- ChangeNotifier
- ValueNotifier<
PagedValue< int, Member> > - PagedValueNotifier<
int, Member> - StreamMemberListController
Constructors
-
StreamMemberListController({required Channel channel, Filter? filter, List<
SortOption> ? sort, int limit = defaultMemberPagedLimit}) - Creates a Stream member list controller.
-
StreamMemberListController.fromValue(PagedValue<
int, Member> value, {required Channel channel, Filter? filter, List<SortOption> ? sort, int limit = defaultMemberPagedLimit}) -
Creates a StreamMemberListController from the passed
value
.
Properties
- channel → Channel
-
The client to use for the channels list.
final
-
currentItems
→ List<
Member> -
Returns the currently loaded items
no setterinherited
- filter ↔ Filter?
-
Allows for the change of filters used for member queries.
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 member list. The default is set to
defaultMemberPagedLimit.
final
-
members
← List<
Member> -
Replaces the previously loaded members with
members
and updates the nextPageKey.no getter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sort
↔ List<
SortOption> ? -
Allows for the change of the query sort used for member queries.
finalgetter/setter pair
-
value
↔ PagedValue<
int, Member> -
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< Member> newItems) → void -
Appends
newItems
to the previously loaded ones and sets the next page key tonull
.inherited -
appendPage(
{required List< Member> 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