FIRTransaction


@interface FIRTransaction : NSObject

FIRTransaction provides methods to read and write data within a transaction.

See

FIRFirestore#transaction:completion:
  • Declaration

    Objective-C

    - (nonnull id)init;
  • Writes to the document referred to by document. If the document doesn’t yet exist, this method creates it and then sets the data. If the document exists, this method overwrites the document data with the new values.

    Declaration

    Swift

    func setData(_ data: [String : Any], forDocument document: FIRDocumentReference) -> Transaction

    Objective-C

    - (nonnull FIRTransaction *)setData:(nonnull NSDictionary<NSString *, id> *)data
                            forDocument:(nonnull FIRDocumentReference *)document;

    Parameters

    data

    An NSDictionary that contains the fields and data to write to the document.

    document

    A reference to the document whose data should be overwritten.

    Return Value

    This FIRTransaction instance. Used for chaining method calls.

  • Writes to the document referred to by document. If the document doesn’t yet exist, this method creates it and then sets the data. If you pass FIRSetOptions, the provided data will be merged into an existing document.

    Declaration

    Swift

    func setData(_ data: [String : Any], forDocument document: FIRDocumentReference, options: FIRSetOptions) -> Transaction

    Objective-C

    - (nonnull FIRTransaction *)setData:(nonnull NSDictionary<NSString *, id> *)data
                            forDocument:(nonnull FIRDocumentReference *)document
                                options:(nonnull FIRSetOptions *)options;

    Parameters

    data

    An NSDictionary that contains the fields and data to write to the document.

    document

    A reference to the document whose data should be overwritten.

    options

    A FIRSetOptions used to configure the set behavior.

    Return Value

    This FIRTransaction instance. Used for chaining method calls.

  • Updates fields in the document referred to by document. If the document does not exist, the transaction will fail.

    Declaration

    Swift

    func updateData(_ fields: [AnyHashable : Any], forDocument document: FIRDocumentReference) -> Transaction

    Objective-C

    - (nonnull FIRTransaction *)updateData:(nonnull NSDictionary<id, id> *)fields
                               forDocument:(nonnull FIRDocumentReference *)document;

    Parameters

    fields

    An NSDictionary containing the fields (expressed as an NSString or FIRFieldPath) and values with which to update the document.

    document

    A reference to the document whose data should be updated.

    Return Value

    This FIRTransaction instance. Used for chaining method calls.

  • Deletes the document referred to by document.

    Declaration

    Swift

    func deleteDocument(_ document: FIRDocumentReference) -> Transaction

    Objective-C

    - (nonnull FIRTransaction *)deleteDocument:
        (nonnull FIRDocumentReference *)document;

    Parameters

    document

    A reference to the document that should be deleted.

    Return Value

    This FIRTransaction instance. Used for chaining method calls.

  • Reads the document referenced by document.

    Declaration

    Swift

    func getDocument(_ document: FIRDocumentReference) throws -> FIRDocumentSnapshot

    Objective-C

    - (FIRDocumentSnapshot *_Nullable)
    getDocument:(nonnull FIRDocumentReference *)document
          error:(NSError *_Nullable *_Nullable)error;

    Parameters

    document

    A reference to the document to be read.

    error

    An out parameter to capture an error, if one occurred.