Files
firebase-ios-sdk/Firestore/Source/Core/FSTTransaction.h
T
Gil 4fbc96904f Use fully qualified imports in Firestore (#467)
This simplifies the import process back into google3 and allows us to add additional directories to the project without needing to update the project files for each directory we add. This shows up most clearly in the change to Firestore/Example/Firestore.xcodeproj/project.pbxproj: this no longer needs to list essentially every directory in the project as a header search path.

* Clang-format configuration for C++ files
* Add support C++-only sources to the podspec
* Podspec support for fully qualified imports
* xcodeproj changes for fully-qualified imports
* Use fully-qualified imports in Firestore sources
2017-11-16 20:52:01 -08:00

74 lines
2.3 KiB
Objective-C

/*
* Copyright 2017 Google
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import <Foundation/Foundation.h>
#import "Firestore/Source/Core/FSTTypes.h"
@class FIRSetOptions;
@class FSTDatastore;
@class FSTDocumentKey;
@class FSTFieldMask;
@class FSTFieldTransform;
@class FSTMaybeDocument;
@class FSTObjectValue;
@class FSTParsedSetData;
@class FSTParsedUpdateData;
NS_ASSUME_NONNULL_BEGIN
#pragma mark - FSTTransaction
/** Provides APIs to use in a transaction context. */
@interface FSTTransaction : NSObject
/** Creates a new transaction object, which can only be used for one transaction attempt. **/
+ (instancetype)transactionWithDatastore:(FSTDatastore *)datastore;
/**
* Takes a set of keys and asynchronously attempts to fetch all the documents from the backend,
* ignoring any local changes.
*/
- (void)lookupDocumentsForKeys:(NSArray<FSTDocumentKey *> *)keys
completion:(FSTVoidMaybeDocumentArrayErrorBlock)completion;
/**
* Stores mutation for the given key and set data, to be committed when commitWithCompletion is
* called.
*/
- (void)setData:(FSTParsedSetData *)data forDocument:(FSTDocumentKey *)key;
/**
* Stores mutations for the given key and update data, to be committed when commitWithCompletion
* is called.
*/
- (void)updateData:(FSTParsedUpdateData *)data forDocument:(FSTDocumentKey *)key;
/**
* Stores a delete mutation for the given key, to be committed when commitWithCompletion is called.
*/
- (void)deleteDocument:(FSTDocumentKey *)key;
/**
* Attempts to commit the mutations set on this transaction. Calls the given completion block when
* finished. Once this is called, no other mutations or commits are allowed on the transaction.
*/
- (void)commitWithCompletion:(FSTVoidErrorBlock)completion;
@end
NS_ASSUME_NONNULL_END