IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Transaction

public class Transaction

The Transaction class encapsulates the functionality needed to perform a transaction on the data at a location. To run a transaction, provide a Handler to runTransaction. That handler will be passed the current data at the location, and must return a Result. A Result can be created using either success or abort.

Summary

Nested types
`public interface Transaction.Handler` An object implementing this interface is used to run a transaction, and will be notified of the results of the transaction.
`public class Transaction.Result` Instances of this class represent the desired outcome of a single run of a `Handler`'s doTransaction method.

Public constructors
`Transaction()`

Public methods
`static @NonNull Transaction.Result`	`abort()`
`static @NonNull Transaction.Result`	`success(@NonNull MutableData resultData)`

Public constructors

Transaction

public Transaction()

Public methods

abort

public static @NonNull Transaction.Result abort()

Returns
`@NonNull Transaction.Result`	A `Result` that aborts the transaction

success

public static @NonNull Transaction.Result success(@NonNull MutableData resultData)

Parameters
`@NonNull MutableData resultData`	The desired data at the location

Returns
`@NonNull Transaction.Result`	A `Result` indicating the new data to be stored at the location

Transaction

Summary

Nested types

Public constructors

Public methods

Public constructors

Transaction

Public methods

abort

success