Firebase.Firestore.Transaction

A transaction, as created by FirebaseFirestore.RunTransactionAsync{T}(System.Func{Transaction, Task{T}}) (and overloads) and passed to user code.

Summary

Properties

Firestore
The database for this transaction.

Public functions

Delete(DocumentReference documentReference)
void
Deletes the document referenced by the providedDocumentReference.
GetSnapshotAsync(DocumentReference documentReference)
Read a snapshot of the document specified bydocumentReference , with respect to this transaction.
Set(DocumentReference documentReference, object documentData,SetOptions options)
void
Writes to the document referred to by the providedDocumentReference.
Update(DocumentReference documentReference, IDictionary< string, object > updates)
void
Updates fields in the document referred to by the providedDocumentReference.
Update(DocumentReference documentReference, string field, object value)
void
Updates the field in the document referred to by the providedDocumentReference.
Update(DocumentReference documentReference, IDictionary<FieldPath, object > updates)
void
Updates fields in the document referred to by the providedDocumentReference.

Properties

Firestore

FirebaseFirestoreFirestore

The database for this transaction.

Public functions

Delete

voidDelete(DocumentReferencedocumentReference)

Deletes the document referenced by the providedDocumentReference.

Details
Parameters
documentReference
The document to delete. Must not benull.

GetSnapshotAsync

Task<DocumentSnapshot>GetSnapshotAsync(DocumentReferencedocumentReference)

Read a snapshot of the document specified bydocumentReference , with respect to this transaction.

This method cannot be called after any write operations have been created.

Details
Parameters
documentReference
The document reference to read. Must not benull.
Returns
A snapshot of the given document with respect to this transaction.

Set

voidSet(DocumentReferencedocumentReference,objectdocumentData,SetOptionsoptions)

Writes to the document referred to by the providedDocumentReference.

If the document does not yet exist, it will be created. If you passoptions , the provided data can be merged into an existing document.

Details
Parameters
documentReference
The document in which to set the data. Must not benull.
documentData
The data for the document. Must not benull.
options
The options to use when updating the document. May benull, which is equivalent toSetOptions.Overwrite.

Update

voidUpdate(DocumentReferencedocumentReference,IDictionary<string,object>updates)

Updates fields in the document referred to by the providedDocumentReference.

If no document exists yet, the update will fail.

Details
Parameters
documentReference
The document to update. Must not benull.
updates
A dictionary of field / value pairs to update. Fields can contain dots to reference nested fields in the document. Fields not present in this dictionary are not updated. Must not benull.

Update

voidUpdate(DocumentReferencedocumentReference,stringfield,objectvalue)

Updates the field in the document referred to by the providedDocumentReference.

If no document exists yet, the update will fail.

Details
Parameters
documentReference
The document to update. Must not benull.
field
The dot-separated name of the field to update. Must not benull.
value
The new value for the field. May benull.

Update

voidUpdate(DocumentReferencedocumentReference,IDictionary<FieldPath,object>updates)

Updates fields in the document referred to by the providedDocumentReference.

If no document exists yet, the update will fail.

Details
Parameters
documentReference
The document to update. Must not benull.
updates
A dictionary of field / value pairs to update. Fields not present in this dictionary are not updated. Must not benull.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2022-07-27 UTC.