blob: d1371fa5f83a7d2600367ffb6361bd6484d6b715 (
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*
* 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 "Firestore/core/include/firebase/firestore/timestamp.h"
#include "Firestore/core/src/firebase/firestore/model/database_id.h"
#include "Firestore/core/src/firebase/firestore/model/document_key.h"
#include "Firestore/core/src/firebase/firestore/model/snapshot_version.h"
@class FSTFieldValue;
@class FSTMaybeDocument;
@class FSTMutation;
@class FSTMutationBatch;
@class FSTMutationResult;
@class FSTObjectValue;
@class FSTQuery;
@class FSTQueryData;
@class FSTWatchChange;
@class GCFSBatchGetDocumentsResponse;
@class GCFSDocument;
@class GCFSDocumentMask;
@class GCFSListenResponse;
@class GCFSTarget;
@class GCFSTarget_DocumentsTarget;
@class GCFSTarget_QueryTarget;
@class GCFSValue;
@class GCFSWrite;
@class GCFSWriteResult;
@class GPBTimestamp;
NS_ASSUME_NONNULL_BEGIN
/**
* Converts internal model objects to their equivalent protocol buffer form. Methods starting with
* "encoded" convert to a protocol buffer and methods starting with "decoded" convert from a
* protocol buffer.
*
* Throws an exception if a protocol buffer is missing a critical field or has a value we can't
* interpret.
*/
@interface FSTSerializerBeta : NSObject
- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithDatabaseID:(const firebase::firestore::model::DatabaseId *)databaseID
NS_DESIGNATED_INITIALIZER;
- (GPBTimestamp *)encodedTimestamp:(const firebase::Timestamp &)timestamp;
- (firebase::Timestamp)decodedTimestamp:(GPBTimestamp *)timestamp;
- (GPBTimestamp *)encodedVersion:(const firebase::firestore::model::SnapshotVersion &)version;
- (firebase::firestore::model::SnapshotVersion)decodedVersion:(GPBTimestamp *)version;
/** Returns the database ID, such as `projects/{project id}/databases/{database_id}`. */
- (NSString *)encodedDatabaseID;
- (NSString *)encodedDocumentKey:(const firebase::firestore::model::DocumentKey &)key;
- (firebase::firestore::model::DocumentKey)decodedDocumentKey:(NSString *)key;
- (GCFSValue *)encodedFieldValue:(FSTFieldValue *)fieldValue;
- (FSTFieldValue *)decodedFieldValue:(GCFSValue *)valueProto;
- (GCFSWrite *)encodedMutation:(FSTMutation *)mutation;
- (FSTMutation *)decodedMutation:(GCFSWrite *)mutation;
- (FSTMutationResult *)decodedMutationResult:(GCFSWriteResult *)mutation;
- (nullable NSMutableDictionary<NSString *, NSString *> *)encodedListenRequestLabelsForQueryData:
(FSTQueryData *)queryData;
- (GCFSTarget *)encodedTarget:(FSTQueryData *)queryData;
- (GCFSTarget_DocumentsTarget *)encodedDocumentsTarget:(FSTQuery *)query;
- (FSTQuery *)decodedQueryFromDocumentsTarget:(GCFSTarget_DocumentsTarget *)target;
- (GCFSTarget_QueryTarget *)encodedQueryTarget:(FSTQuery *)query;
- (FSTQuery *)decodedQueryFromQueryTarget:(GCFSTarget_QueryTarget *)target;
- (FSTWatchChange *)decodedWatchChange:(GCFSListenResponse *)watchChange;
- (firebase::firestore::model::SnapshotVersion)versionFromListenResponse:
(GCFSListenResponse *)watchChange;
- (GCFSDocument *)encodedDocumentWithFields:(FSTObjectValue *)objectValue
key:(const firebase::firestore::model::DocumentKey &)key;
/**
* Encodes an FSTObjectValue into a dictionary.
* @return a new dictionary that can be assigned to a field in another proto.
*/
- (NSMutableDictionary<NSString *, GCFSValue *> *)encodedFields:(FSTObjectValue *)value;
- (FSTObjectValue *)decodedFields:(NSDictionary<NSString *, GCFSValue *> *)fields;
- (FSTMaybeDocument *)decodedMaybeDocumentFromBatch:(GCFSBatchGetDocumentsResponse *)response;
@end
NS_ASSUME_NONNULL_END
|
