FirebaseFirestore
The entry point of Cloud Firestore, mirroring com.google.firebase.firestore.FirebaseFirestore from the Firebase Android SDK: obtained per FirebaseApp and database with the static accessors (or the Firebase.firestore extensions), it creates references, batches and transactions and manages the network and the local cache.
Not mirrored: loadBundle from JVM streams (see api/android-sdk/exclusions.txt).
The entry point of Cloud Firestore, mirroring com.google.firebase.firestore.FirebaseFirestore from the Firebase Android SDK: obtained per FirebaseApp and database with the static accessors (or the Firebase.firestore extensions), it creates references, batches and transactions and manages the network and the local cache.
Not mirrored: loadBundle from JVM streams (see api/android-sdk/exclusions.txt).
The JS SDK's Firestore must be initialised with its settings (and connected to the emulator) before any use, so the underlying object is created on first use with the settings set until then, as the Android SDK's semantics require. Instances are cached per app and database, as the Android SDK's getInstance.
The JS SDK's Firestore must be initialised with its settings (and connected to the emulator) before any use, so the underlying object is created on first use with the settings set until then, as the Android SDK's semantics require. Instances are cached per app and database, as the Android SDK's getInstance.
Types
Properties
The FirebaseApp this instance belongs to.
The FirebaseApp this instance belongs to.
The FirebaseApp this instance belongs to.
The FirebaseApp this instance belongs to.
The FirebaseApp this instance belongs to.
The settings; can only be set before the instance is used.
The iOS SDK does not expose the cache settings it was given, so the settings set through the layer are kept per instance.
The settings; can only be set before the instance is used.
The settings; can only be set before the instance is used.
The settings; can only be set before the instance is used.
The manager of the persistent cache's indexes, or null when persistence is disabled.
The manager of the persistent cache's indexes, or null when persistence is disabled.
The manager of the persistent cache's indexes, or null when persistence is disabled.
The manager of the persistent cache's indexes, or null when persistence is disabled.
The manager of the persistent cache's indexes, or null when persistence is disabled.
Functions
Registers runnable to be called whenever all the active snapshot listeners are in sync.
Registers runnable to be called whenever all the active snapshot listeners are in sync.
Registers runnable to be called whenever all the active snapshot listeners are in sync.
Registers runnable to be called whenever all the active snapshot listeners are in sync.
Registers runnable to be called whenever all the active snapshot listeners are in sync.
Clears the persistent cache; only allowed while the instance is not started or is terminated.
Clears the persistent cache; only allowed while the instance is not started or is terminated.
Clears the persistent cache; only allowed while the instance is not started or is terminated.
Clears the persistent cache; only allowed while the instance is not started or is terminated.
Clears the persistent cache; only allowed while the instance is not started or is terminated.
A CollectionReference for the collection at collectionPath.
A CollectionReference for the collection at collectionPath.
A CollectionReference for the collection at collectionPath.
A CollectionReference for the collection at collectionPath.
A CollectionReference for the collection at collectionPath.
A Query over every collection named collectionId.
A Query over every collection named collectionId.
A Query over every collection named collectionId.
A Query over every collection named collectionId.
A Query over every collection named collectionId.
Disables network access; reads are served from the cache and writes are queued.
Disables network access; reads are served from the cache and writes are queued.
Disables network access; reads are served from the cache and writes are queued.
Disables network access; reads are served from the cache and writes are queued.
Disables network access; reads are served from the cache and writes are queued.
A DocumentReference for the document at documentPath.
A DocumentReference for the document at documentPath.
A DocumentReference for the document at documentPath.
A DocumentReference for the document at documentPath.
A DocumentReference for the document at documentPath.
Re-enables network access after disableNetwork.
Re-enables network access after disableNetwork.
Re-enables network access after disableNetwork.
Re-enables network access after disableNetwork.
Re-enables network access after disableNetwork.
Loads a Firestore bundle into the local cache.
Loads a Firestore bundle into the local cache.
Loads a Firestore bundle into the local cache.
Loads a Firestore bundle into the local cache.
Loads a Firestore bundle into the local cache.
The sources of pipelines over this database (Firestore Pipelines, a Firestore Enterprise edition feature).
The sources of pipelines over this database (Firestore Pipelines, a Firestore Enterprise edition feature).
The sources of pipelines over this database (Firestore Pipelines, a Firestore Enterprise edition feature).
The sources of pipelines over this database (Firestore Pipelines, a Firestore Enterprise edition feature).
The sources of pipelines over this database (Firestore Pipelines, a Firestore Enterprise edition feature).
Runs batchFunction on a new WriteBatch and commits it.
Runs batchFunction on a new WriteBatch and commits it.
Runs batchFunction on a new WriteBatch and commits it.
Runs batchFunction on a new WriteBatch and commits it.
Runs batchFunction on a new WriteBatch and commits it.
Runs updateFunction in a transaction, retrying it on contention, and completes with its result.
Runs updateFunction in a transaction with options and completes with its result.
Runs updateFunction in a transaction, retrying it on contention, and completes with its result.
Runs updateFunction in a transaction with options and completes with its result.
Runs updateFunction in a transaction, retrying it on contention, and completes with its result.
Runs updateFunction in a transaction with options and completes with its result.
Runs updateFunction in a transaction, retrying it on contention, and completes with its result.
Runs updateFunction in a transaction with options and completes with its result.
Runs updateFunction in a transaction, retrying it on contention, and completes with its result.
Runs updateFunction in a transaction with options and completes with its result.
Terminates the instance; further use fails and a new instance is returned by the accessors.
Terminates the instance; further use fails and a new instance is returned by the accessors.
Terminates the instance; further use fails and a new instance is returned by the accessors.
Terminates the instance; further use fails and a new instance is returned by the accessors.
Completes when all the pending writes have been acknowledged by the backend.
Completes when all the pending writes have been acknowledged by the backend.
Completes when all the pending writes have been acknowledged by the backend.
Completes when all the pending writes have been acknowledged by the backend.
Completes when all the pending writes have been acknowledged by the backend.