Ref<State extends Object?> class abstract

An object used by providers to interact with other providers and the life-cycles of the application.

See also:

  • read and watch, two methods that allow a provider to consume other providers.
  • onDispose, a method that allows performing a task when the provider is destroyed.




container ProviderContainer
The ProviderContainer that this provider is associated with.
no setter
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited


exists(ProviderBase<Object?> provider) bool
Determines whether a provider is initialized or not.
invalidate(ProviderOrFamily provider) → void
Invalidates the state of the provider, causing it to refresh.
invalidateSelf() → void
Invalidates the state of the provider, causing it to refresh.
listen<T>(AlwaysAliveProviderListenable<T> provider, void listener(T? previous, T next), {void onError(Object error, StackTrace stackTrace)?, bool fireImmediately}) ProviderSubscription<T>
Listen to a provider and call listener whenever its value changes.
listenSelf(void listener(State? previous, State next), {void onError(Object error, StackTrace stackTrace)?}) → void
Listens to changes on the value exposed by this provider.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
notifyListeners() → void
Notify dependents that this provider has changed.
onAddListener(void cb()) → void
A life-cycle for whenever a new listener is added to the provider.
onCancel(void cb()) → void
Add a listener to perform an operation when the last listener of the provider is removed.
onDispose(void cb()) → void
Adds a listener to perform an operation right before the provider is destroyed.
onRemoveListener(void cb()) → void
A life-cycle for whenever a listener is removed from the provider.
onResume(void cb()) → void
A life-cycle for when a provider is listened again after it was paused (and onCancel was triggered).
read<T>(ProviderListenable<T> provider) → T
Read the state associated with a provider, without listening to that provider.
refresh<T>(Refreshable<T> provider) → T
Forces a provider to re-evaluate its state immediately, and return the created value.
toString() String
A string representation of this object.
watch<T>(AlwaysAliveProviderListenable<T> provider) → T
Obtains the state of a provider and causes the state to be re-evaluated when that provider emits a new value.


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