mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-10 22:45:59 +05:45
Gil
4fbc96904f
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
83 lines
2.9 KiB
Objective-C
83 lines
2.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>
|
|
|
|
#import "Firestore/Source/Core/FSTTypes.h"
|
|
|
|
@class FSTQuery;
|
|
@class FSTSnapshotVersion;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/** An enumeration of the different purposes we have for queries. */
|
|
typedef NS_ENUM(NSInteger, FSTQueryPurpose) {
|
|
/** A regular, normal query. */
|
|
FSTQueryPurposeListen,
|
|
|
|
/** The query was used to refill a query after an existence filter mismatch. */
|
|
FSTQueryPurposeExistenceFilterMismatch,
|
|
|
|
/** The query was used to resolve a limbo document. */
|
|
FSTQueryPurposeLimboResolution,
|
|
};
|
|
|
|
/** An immutable set of metadata that the store will need to keep track of for each query. */
|
|
@interface FSTQueryData : NSObject
|
|
|
|
- (instancetype)initWithQuery:(FSTQuery *)query
|
|
targetID:(FSTTargetID)targetID
|
|
purpose:(FSTQueryPurpose)purpose
|
|
snapshotVersion:(FSTSnapshotVersion *)snapshotVersion
|
|
resumeToken:(NSData *)resumeToken NS_DESIGNATED_INITIALIZER;
|
|
|
|
/** Convenience initializer for use when creating an FSTQueryData for the first time. */
|
|
- (instancetype)initWithQuery:(FSTQuery *)query
|
|
targetID:(FSTTargetID)targetID
|
|
purpose:(FSTQueryPurpose)purpose;
|
|
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
/** Creates a new query data instance with an updated snapshot version and resume token. */
|
|
- (instancetype)queryDataByReplacingSnapshotVersion:(FSTSnapshotVersion *)snapshotVersion
|
|
resumeToken:(NSData *)resumeToken;
|
|
|
|
/** The query being listened to. */
|
|
@property(nonatomic, strong, readonly) FSTQuery *query;
|
|
|
|
/**
|
|
* The targetID to which the query corresponds, assigned by the FSTLocalStore for user queries or
|
|
* the FSTSyncEngine for limbo queries.
|
|
*/
|
|
@property(nonatomic, assign, readonly) FSTTargetID targetID;
|
|
|
|
/** The purpose of the query. */
|
|
@property(nonatomic, assign, readonly) FSTQueryPurpose purpose;
|
|
|
|
/** The latest snapshot version seen for this target. */
|
|
@property(nonatomic, strong, readonly) FSTSnapshotVersion *snapshotVersion;
|
|
|
|
/**
|
|
* An opaque, server-assigned token that allows watching a query to be resumed after disconnecting
|
|
* without retransmitting all the data that matches the query. The resume token essentially
|
|
* identifies a point in time from which the server should resume sending results.
|
|
*/
|
|
@property(nonatomic, copy, readonly) NSData *resumeToken;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|