EntityList<T extends Object> class

Generated Riverpod family for normalized local, remote, and hybrid lists.

Inheritance
Annotations

Constructors

EntityList()

Properties

completeness → ViewCompleteness
no setterinherited
enabled → bool
no setterinherited
fromGraph → EntityDecoder<T>
no setterinherited
future → Future<EntityListSnapshot<T>>
Obtains a Future that resolves with the first state value that is not AsyncLoading.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
query → ListQuery
no setterinherited
queryKey → String
no setterinherited
ref → Ref
The Ref associated with this notifier.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state ↔ AsyncValue<EntityListSnapshot<T>>
The value currently exposed by this notifier.
getter/setter pairinherited
subscribe → bool
no setterinherited
toGraph → EntityEncoder<T>?
no setterinherited
type → String
no setterinherited

Methods

build({required String type, required String queryKey, required EntityDecoder<T> fromGraph, EntityEncoder<T>? toGraph, ListQuery query = const ListQuery(), ViewCompleteness completeness = ViewCompleteness.remote, bool enabled = true, bool subscribe = true}) → Future<EntityListSnapshot<T>>
fetchNextPage() → Future<void>
Load the next cursor page and retain normalized ID membership.
listenSelf(void listener(AsyncValue<EntityListSnapshot<T>>? previous, AsyncValue<EntityListSnapshot<T>> next), {void onError(Object error, StackTrace stackTrace)?}) → RemoveListener
Listens to changes on the value exposed by this provider.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
refetch() → Future<void>
Explicitly revalidate the first page with the bounded retry policy.
runBuild() → WhenComplete?
Executes Notifier.build.
inherited
toString() → String
A string representation of this object.
inherited
update(FutureOr<EntityListSnapshot<T>> cb(EntityListSnapshot<T> previousState), {FutureOr<EntityListSnapshot<T>> onError(Object err, StackTrace stackTrace)?}) → Future<EntityListSnapshot<T>>
A function to update state from its previous value, while abstracting loading/error cases for state.
inherited
updateShouldNotify(AsyncValue<EntityListSnapshot<T>> previous, AsyncValue<EntityListSnapshot<T>> next) → bool
A method invoked when the state exposed by this Notifier changes. It compares the previous and new value, and return whether listeners should be notified.
inherited

Operators

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