mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-11 22:55:59 +05:45
Ryan Wilson
7386f00178
* Replacing FIR_SWIFT_NAME macro with NS_SWIFT_NAME. This pushes the minimum Xcode version to 7.3, as NS_SWIFT_NAME was limited before that version (which is why the macro was introduced in the first place). * Fixed FIRMessaging header
105 lines
3.9 KiB
Objective-C
105 lines
3.9 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>
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
@class FIRDocumentReference;
|
|
@class FIRDocumentSnapshot;
|
|
@class FIRSetOptions;
|
|
|
|
/**
|
|
* `FIRTransaction` provides methods to read and write data within a transaction.
|
|
*
|
|
* @see FIRFirestore#transaction:completion:
|
|
*/
|
|
NS_SWIFT_NAME(Transaction)
|
|
@interface FIRTransaction : NSObject
|
|
|
|
/** */
|
|
- (id)init __attribute__((unavailable("FIRTransaction cannot be created directly.")));
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param data An `NSDictionary` that contains the fields and data to write to the document.
|
|
* @param document A reference to the document whose data should be overwritten.
|
|
* @return This `FIRTransaction` instance. Used for chaining method calls.
|
|
*/
|
|
// clang-format off
|
|
- (FIRTransaction *)setData:(NSDictionary<NSString *, id> *)data
|
|
forDocument:(FIRDocumentReference *)document
|
|
NS_SWIFT_NAME(setData(_:forDocument:));
|
|
// clang-format on
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param data An `NSDictionary` that contains the fields and data to write to the document.
|
|
* @param document A reference to the document whose data should be overwritten.
|
|
* @param options A `FIRSetOptions` used to configure the set behavior.
|
|
* @return This `FIRTransaction` instance. Used for chaining method calls.
|
|
*/
|
|
// clang-format off
|
|
- (FIRTransaction *)setData:(NSDictionary<NSString *, id> *)data
|
|
forDocument:(FIRDocumentReference *)document
|
|
options:(FIRSetOptions *)options
|
|
NS_SWIFT_NAME(setData(_:forDocument:options:));
|
|
// clang-format on
|
|
|
|
/**
|
|
* Updates fields in the document referred to by `document`.
|
|
* If the document does not exist, the transaction will fail.
|
|
*
|
|
* @param fields An `NSDictionary` containing the fields (expressed as an `NSString` or
|
|
* `FIRFieldPath`) and values with which to update the document.
|
|
* @param document A reference to the document whose data should be updated.
|
|
* @return This `FIRTransaction` instance. Used for chaining method calls.
|
|
*/
|
|
// clang-format off
|
|
- (FIRTransaction *)updateData:(NSDictionary<id, id> *)fields
|
|
forDocument:(FIRDocumentReference *)document
|
|
NS_SWIFT_NAME(updateData(_:forDocument:));
|
|
// clang-format on
|
|
|
|
/**
|
|
* Deletes the document referred to by `document`.
|
|
*
|
|
* @param document A reference to the document that should be deleted.
|
|
* @return This `FIRTransaction` instance. Used for chaining method calls.
|
|
*/
|
|
- (FIRTransaction *)deleteDocument:(FIRDocumentReference *)document
|
|
NS_SWIFT_NAME(deleteDocument(_:));
|
|
|
|
/**
|
|
* Reads the document referenced by `document`.
|
|
*
|
|
* @param document A reference to the document to be read.
|
|
* @param error An out parameter to capture an error, if one occurred.
|
|
*/
|
|
- (FIRDocumentSnapshot *_Nullable)getDocument:(FIRDocumentReference *)document
|
|
error:(NSError *__autoreleasing *)error
|
|
NS_SWIFT_NAME(getDocument(_:));
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|