mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-11 22:55:59 +05:45
Gil
7a7eced747
use namespace aliases instead. This makes the Objective-C code much more like what it's going to end up being like when translated to C++: headers will include classes declared in a namespace relative to firebase::firestore so everything else will be named relative to firebase::firestore. Meanwhile the using statements in the headers were causing us to miss adding using statements in source files which was moving us away from where we wanted to be.
100 lines
3.4 KiB
Objective-C
100 lines
3.4 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>
|
|
|
|
#include "Firestore/core/src/firebase/firestore/model/document_key.h"
|
|
#include "Firestore/core/src/firebase/firestore/model/field_path.h"
|
|
#include "Firestore/core/src/firebase/firestore/model/snapshot_version.h"
|
|
|
|
@class FSTFieldValue;
|
|
@class GCFSDocument;
|
|
@class FSTObjectValue;
|
|
|
|
namespace model = firebase::firestore::model;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/** Describes the `hasPendingWrites` state of a document. */
|
|
typedef NS_ENUM(NSInteger, FSTDocumentState) {
|
|
/** Local mutations applied via the mutation queue. Document is potentially inconsistent. */
|
|
FSTDocumentStateLocalMutations,
|
|
/** Mutations applied based on a write acknowledgment. Document is potentially inconsistent. */
|
|
FSTDocumentStateCommittedMutations,
|
|
/** No mutations applied. Document was sent to us by Watch. */
|
|
FSTDocumentStateSynced
|
|
};
|
|
|
|
/**
|
|
* The result of a lookup for a given path may be an existing document or a tombstone that marks
|
|
* the path deleted.
|
|
*/
|
|
@interface FSTMaybeDocument : NSObject <NSCopying>
|
|
- (id)init __attribute__((unavailable("Abstract base class")));
|
|
- (const model::DocumentKey &)key;
|
|
- (const model::SnapshotVersion &)version;
|
|
|
|
/**
|
|
* Whether this document has a local mutation applied that has not yet been acknowledged by Watch.
|
|
*/
|
|
- (bool)hasPendingWrites;
|
|
|
|
@end
|
|
|
|
@interface FSTDocument : FSTMaybeDocument
|
|
+ (instancetype)documentWithData:(FSTObjectValue *)data
|
|
key:(model::DocumentKey)key
|
|
version:(model::SnapshotVersion)version
|
|
state:(FSTDocumentState)state;
|
|
|
|
+ (instancetype)documentWithData:(FSTObjectValue *)data
|
|
key:(model::DocumentKey)key
|
|
version:(model::SnapshotVersion)version
|
|
state:(FSTDocumentState)state
|
|
proto:(GCFSDocument *)proto;
|
|
|
|
- (nullable FSTFieldValue *)fieldForPath:(const model::FieldPath &)path;
|
|
- (bool)hasLocalMutations;
|
|
- (bool)hasCommittedMutations;
|
|
|
|
@property(nonatomic, strong, readonly) FSTObjectValue *data;
|
|
|
|
/**
|
|
* Memoized serialized form of the document for optimization purposes (avoids repeated
|
|
* serialization). Might be nil.
|
|
*/
|
|
@property(nonatomic, strong, readonly) GCFSDocument *proto;
|
|
|
|
@end
|
|
|
|
@interface FSTDeletedDocument : FSTMaybeDocument
|
|
+ (instancetype)documentWithKey:(model::DocumentKey)key
|
|
version:(model::SnapshotVersion)version
|
|
hasCommittedMutations:(bool)committedMutations;
|
|
|
|
- (bool)hasCommittedMutations;
|
|
|
|
@end
|
|
|
|
@interface FSTUnknownDocument : FSTMaybeDocument
|
|
+ (instancetype)documentWithKey:(model::DocumentKey)key version:(model::SnapshotVersion)version;
|
|
@end
|
|
|
|
/** An NSComparator suitable for comparing docs using only their keys. */
|
|
extern const NSComparator FSTDocumentComparatorByKey;
|
|
|
|
NS_ASSUME_NONNULL_END
|