java.lang.Object | |
↳ | com.google.firebase.firestore.FirebaseFirestore |
Represents a Firestore Database and is the entry point for all Firestore operations
Subclassing Note: Firestore classes are not meant to be subclassed except for use in test mocks. Subclassing is not supported in production code and new SDK releases may break code that does so.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a write batch, used for performing multiple writes as a single atomic operation.
| |||||||||||
Gets a CollectionReference instance that refers to the collection at the specified path within
the database.
| |||||||||||
Disables network access for this instance.
| |||||||||||
Gets a `DocumentReference` instance that refers to the document at the specified path within
the database.
| |||||||||||
Re-enables network usage for this instance after a prior call to disableNetwork().
| |||||||||||
Returns the FirebaseApp instance to which this FirebaseFirestore belongs.
| |||||||||||
Returns the settings used by this FirebaseFirestore object.
| |||||||||||
Executes the given updateFunction and then attempts to commit the changes applied within the
transaction.
| |||||||||||
Sets any custom settings used to configure this FirebaseFirestore object.
| |||||||||||
Globally enables / disables Firestore logging for the SDK.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Creates a write batch, used for performing multiple writes as a single atomic operation.
Returns | |
---|---|
WriteBatch |
The created WriteBatch object. |
Gets a CollectionReference instance that refers to the collection at the specified path within the database.
Parameters | |
---|---|
collectionPath |
String : A slash-separated path to a collection. |
Returns | |
---|---|
CollectionReference |
The CollectionReference instance. |
Disables network access for this instance. While the network is disabled, any snapshot listeners or get() calls will return results from cache, and any write operations will be queued until network usage is re-enabled via a call to enableNetwork().
Returns | |
---|---|
Task<Void> |
A Task that will be completed once networking is disabled. |
Gets a `DocumentReference` instance that refers to the document at the specified path within the database.
Parameters | |
---|---|
documentPath |
String : A slash-separated path to a document. |
Returns | |
---|---|
DocumentReference |
The DocumentReference instance. |
Re-enables network usage for this instance after a prior call to disableNetwork().
Returns | |
---|---|
Task<Void> |
A Task that will be completed once networking is enabled. |
Returns the FirebaseApp instance to which this FirebaseFirestore belongs.
Returns | |
---|---|
FirebaseApp |
The FirebaseApp instance to which this FirebaseFirestore belongs. |
Returns the settings used by this FirebaseFirestore object.
Returns | |
---|---|
FirebaseFirestoreSettings |
Parameters | |
---|---|
app |
FirebaseApp |
Returns | |
---|---|
FirebaseFirestore |
Executes the given updateFunction and then attempts to commit the changes applied within the transaction. If any document read within the transaction has changed, the updateFunction will be retried. If it fails to commit after 5 attempts, the transaction will fail.
Parameters | |
---|---|
updateFunction |
Function : The function to execute within the transaction context. |
Returns | |
---|---|
Task<TResult> |
The task returned from the updateFunction. |
Sets any custom settings used to configure this FirebaseFirestore object. This method can only be called before calling any other methods on this object.
Parameters | |
---|---|
settings |
FirebaseFirestoreSettings |
Globally enables / disables Firestore logging for the SDK.
Parameters | |
---|---|
loggingEnabled |
boolean |