blob: ab59bdef8bd98cac3b25a4aa75c22e2385fb0263 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
/*
* 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>
#include <vector>
#import "Firestore/Source/Core/FSTTypes.h"
#include "Firestore/core/src/firebase/firestore/model/document_key.h"
@class FSTDatastore;
@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:(const std::vector<firebase::firestore::model::DocumentKey> &)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:(const firebase::firestore::model::DocumentKey &)key;
/**
* Stores mutations for the given key and update data, to be committed when commitWithCompletion
* is called.
*/
- (void)updateData:(FSTParsedUpdateData *)data
forDocument:(const firebase::firestore::model::DocumentKey &)key;
/**
* Stores a delete mutation for the given key, to be committed when commitWithCompletion is called.
*/
- (void)deleteDocument:(const firebase::firestore::model::DocumentKey &)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
|
