Transaction class Null safety

A reference to a transaction. The Transaction object passed to a transaction's updateFunction() provides the methods to read and write data within the transaction context. See: Firestore.runTransaction().



hashCode int
The hash code for this object. [...]
read-only, inherited
jsObject → TransactionJsImpl
JS object.
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited


delete(DocumentReference documentRef) Transaction
Deletes the document referred to by the provided DocumentReference. [...]
get(DocumentReference documentRef) Future<DocumentSnapshot>
Reads the document referenced by the provided DocumentReference. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
set(DocumentReference documentRef, Map<String, dynamic> data, [SetOptions? options]) Transaction
Writes to the document referred to by the provided DocumentReference. If the document does not exist yet, it will be created. If you pass options, the provided data can be merged into the existing document. [...]
toString() String
A string representation of this object. [...]
update(DocumentReference documentRef, {Map<String, dynamic>? data, List? fieldsAndValues}) Transaction
Updates fields in the document referred to by this DocumentReference. The update will fail if applied to a document that does not exist. The value must not be null. [...]


operator ==(Object other) bool
The equality operator. [...]

Static Methods

getInstance(TransactionJsImpl jsObject) Transaction
Creates a new Transaction from a jsObject.