BaseViewModel class - stacked library

Constructors

BaseViewModel()

Properties

anyObjectsBusy → bool: no setter
disposed → bool: no setter
hasError → bool: Returns the error existence status of the ViewModel
no setter
hashCode → int: The hash code for this object.
no setterinherited
hasListeners → bool: Whether any listeners are currently registered.
no setterinherited
hasMessage → bool: Returns the message status of the ViewModel
no setter
initialised → bool: no setter
isBusy → bool: Returns the busy status of the ViewModel
no setter
modelError → dynamic: Returns the error status of the ViewModel
no setter
modelMessage → String?: Returns the message status of the ViewModel
no setter
onModelReadyCalled → bool: no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

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
clearMessages() → void
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
hasMessageForKey(Object key) → bool: Returns a boolean that indicates if the ViewModel has an message for the key
message(Object object) → String?: Returns the message for an object if it exists. Returns null if not present
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent 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
setMessage(String? message) → void: Sets the message for the ViewModel
setMessageForObject(Object object, String? value) → void: Sets the message 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
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