FirestoreDocumentMetaMixin<T> mixin

A mix-in to save uid, time and locale when saving Firestore documents.

Superclass Constraints
Mixin Applications

Properties

disposed bool
True if the model is Disposed.
no setterinherited
firestore FirebaseFirestore
A valid Firestore instance.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
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 setterinherited
loaded bool
It becomes true after loadOnce is executed.
no setterinherited
loading Future<void>?
Returns itself after the load finishes.
no setterinherited
localeValueKey String
Key for locale values.
finalinherited
notifyOnChangeValue bool
If this value is true, the change will be notified when value itself is changed.
no setterinherited
parameters Map<String, String>
Parameters for the query.
finalinherited
path String
Path of the firestore database.
finalinherited
reference DocumentReference<DynamicMap>
You can change the Firestore reference.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
saving Future<void>?
Returns itself after the save/delete finishes.
no setterinherited
subscriptions List<StreamSubscription>
A list of documents to which you are currently subscribed.
finalinherited
timeValueKey String
Key for time values.
finalinherited
uidValueKey String
Key for UID values.
finalinherited
value ↔ T
The current value stored in this notifier.
getter/setter pairinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
delete() Future<void>
Delete this document.
inherited
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).
inherited
fetch([bool listen = true]) Future<void>
Provides the best data acquisition method to implement during screen build.
inherited
filterOnLoad(DynamicMap loaded) DynamicMap
You can filter the loaded content when it is loaded.
inherited
filterOnSave(DynamicMap save) DynamicMap
You can filter the saving content when it is saving.
override
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
listen() Future<void>
Load data while monitoring Firestore for real-time updates.
inherited
load() Future<void>
Retrieves data and updates the data in the model.
inherited
loadOnce() Future<void>
If the data is empty, load is performed only once.
inherited
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.
inherited
onDidDelete() Future<void>
Callback after the delete has been done.
inherited
onDidListen() Future<void>
Callback after the listen has been done.
inherited
onDidLoad() Future<void>
Callback after the load has been done.
inherited
onDidSave() Future<void>
Callback after the save has been done.
inherited
onListen() Future<void>
Callback before the listen has been done.
inherited
onLoad() Future<void>
Callback before the load has been done.
inherited
onSave() Future<void>
Callback before the save has been done.
inherited
reload() Future<void>
Reload data and updates the data in the model.
inherited
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.
inherited
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() FirestoreDocumentTransactionBuilder
Generate a Transaction for this document.
inherited

Operators

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