BaseNotifier<T> class
abstract
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
ref
→ NotifierProviderRef<
BaseState< T> > -
The
Ref
from the provider associated with thisNotifier
.no setterinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
↔ BaseState<
T> -
The value currently exposed by this
Notifier
.getter/setter pairinherited -
stateOrNull
→ BaseState<
T> ? -
The value currently exposed by this
Notifier
.no setterinherited
Methods
-
build(
) → BaseState< T> - do not override in child classes, use prepareForBuild instead
-
cancelThrottle(
{String throttleIdentifier = ''}) → void -
Cancels if throttling is in progress
inherited
-
clearGlobalLoading(
) → void -
Clear BaseLoadingIndicator
inherited
-
debounce(
{Duration duration = const Duration(milliseconds: 500)}) → Future< void> -
Wait to collect multiple method calls for certain duration before allowing only one method call to proceed
inherited
-
execute(
EitherFailureOr< T> function, {PreHandleData<T> ? onDataReceived, PreHandleFailure? onFailureOccurred, bool withLoadingState = true, bool globalLoading = false, bool globalFailure = true}) → Future<void> -
Executes received
function
with additional parameters to control if loading state should be set while executingfunction
by providingwithLoadingState
param.inherited -
executeStreamed(
StreamFailureOr< T> function, {PreHandleData<T> ? onDataReceived, PreHandleFailure? onFailureOccurred, bool withLoadingState = true, bool globalLoading = false, bool globalFailure = true}) → Future<void> -
Executes received stream
function
with additional parameters to control if loading state should be set while executingfunction
by providingwithLoadingState
param. Usage is the same as the execute method with the main difference in number offunction
results (and consequently number of state updates) as it is a stream of datainherited -
initWithRef(
Ref< Object?> ref) → void -
inherited
-
initWithRefAndGetOrUpdateState(
Ref< Object?> ref, BaseState<T> getOrUpdateState({BaseState<T> ? newState})) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
on<
U> (AlwaysAliveProviderListenable< U> provider, void invokeFunction(U? previous, U next), {bool skipUpdateCondition(U? previous, U next)?}) → void -
Subscribe to another notifier's state changes
inherited
-
prepareForBuild(
) → void -
setGlobalFailure(
Failure? failure) → void -
inherited
-
setGlobalInfo(
GlobalInfo? globalInfo) → void -
inherited
-
showGlobalLoading(
) → void -
Show BaseLoadingIndicator above the entire app
inherited
-
throttle(
Future< void> function(), {Duration duration = const Duration(milliseconds: 500), bool waitForFunction = true, String throttleIdentifier = ''}) → Future<void> -
Execute given function and then block further executing of the same function for certain duration.
waitForFunction
if set to true it will wait if function finishes after provided duration delay, otherwise will finish immediately after given durationinherited -
toString(
) → String -
A string representation of this object.
inherited
-
updateShouldNotify(
BaseState< T> previous, BaseState<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