ModelRefMixin<T> mixin
A mix-in to define that it is a relationship between models in DocumentBase, etc.
Mix in the document to which you are relating.
DocumentBaseなどにモデル間のリレーションであるということを定義するためのミックスイン。
リレーション先のドキュメントにミックスインしてください。
- Implemented types
-
- ModelRefDocumentBase<
T> - ModelRefBase<
T> - DocumentBase<
T>
- ModelRefDocumentBase<
- Available extensions
Properties
- databaseQuery → ModelAdapterDocumentQuery
-
Database queries for documents.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
no setterinherited
- loaded → bool
-
Returns
true
if the data was successfully loaded by the load method.no setterinherited -
loading
→ Future<
T?> ? -
If load or reload is executed, it waits until the loading process is completed.
no setterinherited
- modelQuery → DocumentModelQuery
-
DocumentModelQuery of the associated document.
finalinherited
-
reloading
→ Future<
T?> ? -
If reload is done, it waits until the loading process is finished.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
saving
→ Future<
void> ? -
If save or delete is executed, it waits until the read process is completed.
no setterinherited
-
subscriptions
→ List<
StreamSubscription> -
List of currently subscribed notifications. All should be canceled when the object is destroyed.
no setterinherited
- uid → String
-
Returns the ID for the document path.
no setterinherited
- value → T?
-
Actual value.
no setterinherited
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes.
inherited
-
batch(
{int splitLength = 100}) → ModelBatchDocumentBuilder< T> -
Builder for batch processing.
inherited
-
compareTo(
ModelRefBase< T> other) → int -
Compares this object to another object.
override
-
delete(
) → Future< void> -
Data can be deleted.
inherited
-
deleteRequest(
) → Future< void> -
Implement internal processing when delete is executed.
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 will throw after the object is disposed).
inherited
-
filterOnDidLoad(
T? value) → Future< T?> -
Callback called after loading.
inherited
-
filterOnLoad(
DynamicMap rawData) → DynamicMap -
Implement filters when loading data.
inherited
-
filterOnSave(
DynamicMap rawData) → DynamicMap -
You can filter the data to be saved.
inherited
-
fromMap(
DynamicMap map) → T -
Defines the object transformation from DynamicMap to
T
, which is output by decoding Json.inherited -
handledOnUpdate(
ModelUpdateNotification update) → Future< void> -
Describe the callback process to be passed to ModelAdapterDocumentQuery.callback.
inherited
-
load(
) → Future< T?> -
Reads documents corresponding to modelQuery.
inherited
-
loadRequest(
) → Future< DynamicMap?> -
Implement internal processing when load or reload is executed.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
reload(
) → Future< T?> -
Reload the document corresponding to modelQuery.
inherited
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
save(
T? newValue) → Future< void> -
Data can be saved.
inherited
-
saveRequest(
DynamicMap map) → Future< void> -
Implement internal processing when save is executed.
inherited
-
toJson(
) → Map< String, dynamic> -
Methods for Json serialization.
override
-
toMap(
T value) → DynamicMap -
Defines the conversion from a
T
object to a DynamicMap that can later be Json encoded.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
transaction(
) → ModelTransactionDocumentBuilder< T> -
Builder for transactions.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited