BaseViewModel class Null safety
Contains ViewModel functionality for busy state management
- Inheritance
- Object
- ChangeNotifier
- BaseViewModel
- Implementers
Constructors
Properties
- anyObjectsBusy → bool
-
read-only
- disposed → bool
-
read-only
- hasError → bool
-
Returns the error status of the ViewModel
read-only
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- hasListeners → bool
-
Whether any listeners are currently registered. [...]
@protected, read-only, inherited
- initialised → bool
-
read-only
- isBusy → bool
-
Returns the busy status of the ViewModel
read-only
- modelError → dynamic
-
Returns the error status of the ViewModel
read-only
- onModelReadyCalled → bool
-
read-only
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes. [...]
inherited
-
busy(
Object? object) → bool - Returns the busy status for an object if it exists. Returns false if not present
-
clearErrors(
) → void - Clears all the errors
-
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). [...]
override
-
error(
Object object) → dynamic -
hasErrorForKey(
Object key) → bool - Returns a boolean that indicates if the ViewModel has an error for the key
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
notifyListeners(
) → void -
Call all the registered listeners. [...]
override
-
onFutureError(
dynamic error, Object? key) → void - Function that is called when a future throws an error
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes. [...]
inherited
-
runBusyFuture<
T> (Future< T> busyFuture, {Object? busyObject, bool throwException = false}) → Future<T> - Sets the ViewModel to busy, runs the future and then sets it to not busy when complete. [...]
-
runErrorFuture<
T> (Future< T> future, {Object? key, bool throwException = false}) → Future<T> -
setBusy(
bool value) → void - Marks the ViewModel as busy and calls notify listeners
-
setBusyForObject(
Object? object, bool value) → void - Sets the busy state for the object equal to the value passed in and notifies Listeners If you're using a primitive type the value SHOULD NOT BE CHANGED, since Hashcode uses == value
-
setError(
dynamic error) → void - Sets the error for the ViewModel
-
setErrorForObject(
Object object, dynamic value) → void - Sets the error state for the object equal to the value passed in and notifies Listeners If you're using a primitive type the value SHOULD NOT BE CHANGED, since Hashcode uses == value
-
setInitialised(
bool value) → void - Sets the initialised value for the ViewModel to true. This is called after the first initialise special ViewModel call
-
setOnModelReadyCalled(
bool value) → void - Sets the onModelReadyCalled value to true. This is called after this first onModelReady call
-
setupStream<
T> (Stream< T> stream, {dynamic onData, dynamic onSubscribed, dynamic onError, dynamic onCancel, dynamic transformData}) → StreamData -
skeletonData<
T> ({required T? realData, required T busyData, Object? busyKey}) → T - returns real data passed if neither the model is busy nor the object passed is busy
-
toString(
) → String -
A string representation of this object. [...]
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited