RuntimeDocumentModel<T> class abstract

Base class for holding and manipulating data from a runtime database as a document of T.

The runtime database is a Json database. Specify a path to specify the location of the contents.

In addition, since it can be used as Map, it is possible to operate the content as it is.

Inheritance
Implemented types
Implementers

Constructors

RuntimeDocumentModel(String path, T initialValue)
Base class for holding and manipulating data from a runtime database as a document of T.

Properties

deleting Future<void>
Returns itself after the delete finishes.
no setter
disposed bool
True if the model is Disposed.
no setterinherited
hashCode int
The hash code for this object.
no setteroverride
hasListeners bool
Whether any listeners are currently registered.
no setterinherited
isEmpty bool
Return true if data is empty.
no setterinherited
isNotEmpty bool
Return true if data is not empty.
no setteroverride
loaded bool
It becomes true after loadOnce is executed.
no setteroverride
loading Future<void>?
Returns itself after the load finishes.
no setteroverride
localeValueKey String
Key for locale values.
final
notifyOnChangeValue bool
If this value is true, the change will be notified when value itself is changed.
no setterinherited
path String
Path of the runtime database.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
saving Future<void>?
Returns itself after the save/delete finishes.
no setteroverride
timeValueKey String
Key for time values.
final
uidValueKey String
Key for UID values.
final
value ↔ T
The current value stored in this notifier.
getter/setter pairinherited-getteroverride-setter

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
delete() Future<void>
Deletes the document.
override
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 and removeListener will throw after the object is disposed).
override
fetch([bool listen = true]) Future<void>
Provides the best data acquisition method to implement during screen build.
override
filterOnLoad(DynamicMap loaded) DynamicMap
You can filter the loaded content when it is loaded.
filterOnSave(DynamicMap save) DynamicMap
You can filter the saving content when it is saving.
fromMap(DynamicMap map) → T
Creates a specific object from a given map.
inherited
initState() → void
The method to be executed when initialization is performed.
inherited
load() Future<void>
Retrieves data and updates the data in the model.
loadOnce() Future<void>
If the data is empty, load is performed only once.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
onDelete() Future<void>
Callback before the delete has been done.
onDidDelete() Future<void>
Callback after the delete has been done.
onDidLoad() Future<void>
Callback after the load has been done.
onDidSave() Future<void>
Callback after the save has been done.
onLoad() Future<void>
Callback before the load has been done.
onSave() Future<void>
Callback before the save has been done.
reload() Future<void>
Reload data and updates the data in the model.
override
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
save() Future<void>
Data stored in the model is stored in a database external to the app that is tied to the model.
override
toMap(T value) DynamicMap
Creates a DynamicMap from its own value.
inherited
toNotifier<V>(V converter(T value)) ValueNotifier<V>
Generates a value notifier.
inherited
toString() String
A string representation of this object.
inherited
transaction() RuntimeDocumentTransactionBuilder
Generate a Transaction for this document.
override

Operators

operator ==(Object other) bool
The equality operator.
override