Ref class Null safety

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 allows a provider to consume other providers.
• onDispose, a method that allows performing a task when the provider is destroyed.

Implementers

• AutoDisposeRef
• FutureProviderRef
• ProviderElementBase
• ProviderRef
• StateNotifierProviderRef
• StateProviderRef
• StreamProviderRef

Constructors

Ref()

Properties

container → ProviderContainer

The ProviderContainer that this provider is associated with.

read-only

hashCode → int

The hash code for this object.

read-only, inherited

runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited

Methods

listen<T>(AlwaysAliveProviderListenable<T> provider, void listener(T? previous, T next), {bool fireImmediately, void onError(Object error, StackTrace stackTrace)?}) → RemoveListener

Listen to a provider and call listener whenever its value changes.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited

onDispose(void cb()) → void

Adds a listener to perform an operation right before the provider is destroyed.

read<T>(ProviderBase<T> provider) → T

Read the state associated with a provider, without listening to that provider.

refresh<State>(ProviderBase<State> provider) → State

Re-create the state of a provider and return the new state.

toString() → String

A string representation of this object.

inherited

watch<T>(AlwaysAliveProviderListenable<T> provider) → T

Obtains the state of a provider and cause the state to be re-evaluated when that provider emits a new value.

Operators

operator ==(Object other) → bool

The equality operator.

inherited