StreamData<T> class
- Inheritance
-
- Object
- ChangeNotifier
- BaseViewModel
- ReactiveViewModel
- DynamicSourceViewModel<
T> - StreamData
- Mixed-in types
Constructors
Properties
- anyObjectsBusy → bool
-
no setterinherited
- changeSource ↔ bool
-
getter/setter pairinherited
- data ↔ T?
-
getter/setter pairinherited
- dataReady → bool
-
Data is ready to be consumed
no setterinherited
- disposed ↔ bool
-
getter/setter pairinherited
- hasError → bool
-
Returns the error existence status of the ViewModel
no setterinherited
- 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 setterinherited
- initialised → bool
-
no setterinherited
- isBusy → bool
-
Returns the busy status of the ViewModel
no setterinherited
-
listenableServices
→ List<
ListenableServiceMixin> -
no setterinherited
- modelError → dynamic
-
Returns the error status of the ViewModel
no setterinherited
- modelMessage → String?
-
Returns the message status of the ViewModel
no setterinherited
- onCancel ↔ Function?
-
Called when the stream is cancelled
getter/setter pair
- onData ↔ Function?
-
Called when the new data arrives
getter/setter pair
- onError ↔ Function?
-
Called when an error is placed on the stream
getter/setter pair
- onModelReadyCalled → bool
-
no setterinherited
- onSubscribed ↔ Function?
-
Called after the stream has been listened too
getter/setter pair
-
reactiveServices
→ List<
ReactiveServiceMixin> -
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stream
↔ Stream<
T> -
getter/setter pair
- transformData ↔ Function?
-
Allows you to modify the data before it's set as the new data for the ViewModel
getter/setter pair
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
inherited
-
clearErrors(
) → void -
Clears all the errors
inherited
-
clearMessages(
) → void -
inherited
-
dispose(
) → void -
Discards any resources used by the object.
override
-
error(
Object object) → dynamic -
inherited
-
hasErrorForKey(
Object key) → bool -
Returns a boolean that indicates if the ViewModel has an error for the key
inherited
-
hasMessageForKey(
Object key) → bool -
Returns a boolean that indicates if the ViewModel has an message for the key
inherited
-
initialise(
) → void -
message(
Object object) → String? -
Returns the message for an object if it exists. Returns null if not present
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
notifySourceChanged(
) → void -
inherited
-
onFutureError(
dynamic error, Object? key) → void -
Function that is called when a future throws an error
inherited
-
rebuildUi(
) → void -
Calls the builder function with this updated viewmodel
inherited
-
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.
inherited
-
runErrorFuture<
T> (Future< T> future, {Object? key, bool throwException = false}) → Future<T> -
inherited
-
setBusy(
bool value) → void -
Marks the ViewModel as busy and calls notify listeners
inherited
-
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
inherited
-
setError(
dynamic error) → void -
Sets the error for the ViewModel
inherited
-
setErrorForModelOrObject(
dynamic value, {Object? key}) → void -
inherited
-
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
inherited
-
setInitialised(
bool value) → void -
Sets the initialised value for the ViewModel to true. This is called after
the first initialise special ViewModel call
inherited
-
setMessage(
String? message) → void -
Sets the message for the ViewModel
inherited
-
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
inherited
-
setOnModelReadyCalled(
bool value) → void -
Sets the onModelReadyCalled value to true. This is called after this first onModelReady call
inherited
-
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
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited