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`	`FirebaseFirestore` The database for this transaction.

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

FirebaseFirestore Firestore

The database for this transaction.

void Delete(
  DocumentReference documentReference
)

Deletes the document referenced by the provided DocumentReference.

Details

Parameters

documentReference

The document to delete. Must not be null.

Task< DocumentSnapshot > GetSnapshotAsync(
  DocumentReference documentReference
)

Read a snapshot of the document specified by documentReference , 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 be null.

Returns

A snapshot of the given document with respect to this transaction.

void Set(
  DocumentReference documentReference,
  object documentData,
  SetOptions options
)

Writes to the document referred to by the provided DocumentReference.

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

Details

Parameters

`documentReference`	The document in which to set the data. Must not be `null`.
`documentData`	The data for the document. Must not be `null`.
`options`	The options to use when updating the document. May be `null`, which is equivalent to SetOptions.Overwrite.

void Update(
  DocumentReference documentReference,
  IDictionary< string, object > updates
)

Updates fields in the document referred to by the provided DocumentReference.

If no document exists yet, the update will fail.

Details

Parameters

`documentReference`	The document to update. Must not be `null`.
`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 be `null`.

void Update(
  DocumentReference documentReference,
  string field,
  object value
)

Updates the field in the document referred to by the provided DocumentReference.

If no document exists yet, the update will fail.

Details

Parameters

`documentReference`	The document to update. Must not be `null`.
`field`	The dot-separated name of the field to update. Must not be `null`.
`value`	The new value for the field. May be `null`.

void Update(
  DocumentReference documentReference,
  IDictionary< FieldPath, object > updates
)

Updates fields in the document referred to by the provided DocumentReference.

If no document exists yet, the update will fail.

Details

Parameters

`documentReference`	The document to update. Must not be `null`.
`updates`	A dictionary of field / value pairs to update. Fields not present in this dictionary are not updated. Must not be `null`.