FirestoreModelAdapterBase class abstract
Base class for implementing FirestoreModelAdapter.
FirestoreModelAdapterを実装するためのベースクラス。
- Implemented types
- Implementers
Constructors
Properties
- availableListen → bool
-
no setterinherited
- database → FirebaseFirestore
-
The Firestore database instance used in the adapter.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- prefix → String?
-
Path prefix.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- validator → DatabaseValidator?
-
Specify the permission validator for the database.
no setter
Methods
-
clearAll(
) → Future< void> -
Delete all data in the database.
inherited
-
clearCache(
) → Future< void> -
If the database is taking a local cache, delete it.
inherited
-
deleteDocument(
ModelAdapterDocumentQuery query) → Future< void> -
Delete data from the platform set by the adapter by passing
query
.inherited -
deleteOnBatch(
ModelBatchRef ref, ModelAdapterDocumentQuery query) → void -
Describe the data deletion process when performing a batch.
inherited
-
deleteOnTransaction(
ModelTransactionRef ref, ModelAdapterDocumentQuery query) → void -
Describe the data deletion process when performing a transaction.
inherited
-
disposeCollection(
ModelAdapterCollectionQuery query) → void -
The associated collection is discarded by passing
query
.inherited -
disposeDocument(
ModelAdapterDocumentQuery query) → void -
The destruction of related documents is handled by passing
query
.inherited -
hasMatch(
{required String path, required String pattern}) → List< String> ? -
Determines if
path
matchespattern
of the formxxxxx/:id/yyyy
.inherited -
listenCollection(
ModelAdapterCollectionQuery query) → Future< List< StreamSubscription> > -
Pass
query
to monitor the collection.inherited -
listenDocument(
ModelAdapterDocumentQuery query) → Future< List< StreamSubscription> > -
Pass
query
to monitor the document.inherited -
loadAggregation<
T> (ModelAdapterCollectionQuery query, ModelAggregateQuery< AsyncAggregateValue> aggregateQuery) → Future<T?> -
Aggregate queries against data collections to retrieve data.
inherited
-
loadCollection(
ModelAdapterCollectionQuery query) → Future< Map< String, DynamicMap> > -
Pass
query
to the platform set by the adapter to retrieve the collection.inherited -
loadDocument(
ModelAdapterDocumentQuery query) → Future< DynamicMap> -
Pass
query
to the platform set by the adapter to retrieve the document.inherited -
loadOnTransaction(
ModelTransactionRef ref, ModelAdapterDocumentQuery query) → FutureOr< DynamicMap> -
Describe the data acquisition process when performing a transaction.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
runBatch(
FutureOr< void> batch(ModelBatchRef ref), int splitLength) → FutureOr<void> -
Processes a batch for execution.
inherited
-
runTransaction(
FutureOr< void> transaction(ModelTransactionRef ref)) → FutureOr<void> -
Do the processing to execute the transaction.
inherited
-
saveDocument(
ModelAdapterDocumentQuery query, DynamicMap value) → Future< void> -
By passing the
query
and thevalue
to be stored, the data is stored on the platform set by the adapter.inherited -
saveOnBatch(
ModelBatchRef ref, ModelAdapterDocumentQuery query, DynamicMap value) → void -
Describe the data storage process when performing a batch.
inherited
-
saveOnTransaction(
ModelTransactionRef ref, ModelAdapterDocumentQuery query, DynamicMap value) → void -
Describes the data storage process when performing a transaction.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited