mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-11 22:55:59 +05:45
rsgowman
a5b3185ed3
Add option to allow the user to control where DocumentReference.getDocument() and CollectionReference.getDocuments() fetches from. By default, it fetches from the server (if possible) and falls back to the local cache. It's now possible to alternatively fetch from the local cache only, or to fetch from the server only (though in the server only case, latency compensation is still enabled).
119 lines
4.8 KiB
Objective-C
119 lines
4.8 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"
|
|
#import "Firestore/Source/Core/FSTViewSnapshot.h"
|
|
#import "Firestore/Source/Remote/FSTRemoteStore.h"
|
|
|
|
#include "Firestore/core/src/firebase/firestore/auth/credentials_provider.h"
|
|
#include "Firestore/core/src/firebase/firestore/core/database_info.h"
|
|
#include "Firestore/core/src/firebase/firestore/model/database_id.h"
|
|
|
|
@class FIRDocumentReference;
|
|
@class FIRDocumentSnapshot;
|
|
@class FIRQuery;
|
|
@class FIRQuerySnapshot;
|
|
@class FSTDatabaseID;
|
|
@class FSTDatabaseInfo;
|
|
@class FSTDispatchQueue;
|
|
@class FSTDocument;
|
|
@class FSTListenOptions;
|
|
@class FSTMutation;
|
|
@class FSTQuery;
|
|
@class FSTQueryListener;
|
|
@class FSTTransaction;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
* FirestoreClient is a top-level class that constructs and owns all of the pieces of the client
|
|
* SDK architecture. It is responsible for creating the worker queue that is shared by all of the
|
|
* other components in the system.
|
|
*/
|
|
@interface FSTFirestoreClient : NSObject <FSTOnlineStateDelegate>
|
|
|
|
/**
|
|
* Creates and returns a FSTFirestoreClient with the given parameters.
|
|
*
|
|
* All callbacks and events will be triggered on the provided userDispatchQueue.
|
|
*/
|
|
+ (instancetype)clientWithDatabaseInfo:(const firebase::firestore::core::DatabaseInfo &)databaseInfo
|
|
usePersistence:(BOOL)usePersistence
|
|
credentialsProvider:(firebase::firestore::auth::CredentialsProvider *)
|
|
credentialsProvider // no passing ownership
|
|
userDispatchQueue:(FSTDispatchQueue *)userDispatchQueue
|
|
workerDispatchQueue:(FSTDispatchQueue *)workerDispatchQueue;
|
|
|
|
- (instancetype)init __attribute__((unavailable("Use static constructor method.")));
|
|
|
|
/** Shuts down this client, cancels all writes / listeners, and releases all resources. */
|
|
- (void)shutdownWithCompletion:(nullable FSTVoidErrorBlock)completion;
|
|
|
|
/** Disables the network connection. Pending operations will not complete. */
|
|
- (void)disableNetworkWithCompletion:(nullable FSTVoidErrorBlock)completion;
|
|
|
|
/** Enables the network connection and requeues all pending operations. */
|
|
- (void)enableNetworkWithCompletion:(nullable FSTVoidErrorBlock)completion;
|
|
|
|
/** Starts listening to a query. */
|
|
- (FSTQueryListener *)listenToQuery:(FSTQuery *)query
|
|
options:(FSTListenOptions *)options
|
|
viewSnapshotHandler:(FSTViewSnapshotHandler)viewSnapshotHandler;
|
|
|
|
/** Stops listening to a query previously listened to. */
|
|
- (void)removeListener:(FSTQueryListener *)listener;
|
|
|
|
/**
|
|
* Retrieves a document from the cache via the indicated completion. If the doc
|
|
* doesn't exist, an error will be sent to the completion.
|
|
*/
|
|
- (void)getDocumentFromLocalCache:(FIRDocumentReference *)doc
|
|
completion:(void (^)(FIRDocumentSnapshot *_Nullable document,
|
|
NSError *_Nullable error))completion;
|
|
|
|
/**
|
|
* Retrieves a (possibly empty) set of documents from the cache via the
|
|
* indicated completion.
|
|
*/
|
|
- (void)getDocumentsFromLocalCache:(FIRQuery *)query
|
|
completion:(void (^)(FIRQuerySnapshot *_Nullable query,
|
|
NSError *_Nullable error))completion;
|
|
|
|
/** Write mutations. completion will be notified when it's written to the backend. */
|
|
- (void)writeMutations:(NSArray<FSTMutation *> *)mutations
|
|
completion:(nullable FSTVoidErrorBlock)completion;
|
|
|
|
/** Tries to execute the transaction in updateBlock up to retries times. */
|
|
- (void)transactionWithRetries:(int)retries
|
|
updateBlock:(FSTTransactionBlock)updateBlock
|
|
completion:(FSTVoidIDErrorBlock)completion;
|
|
|
|
/** The database ID of the databaseInfo this client was initialized with. */
|
|
// Ownes a DatabaseInfo instance, which contains the id here.
|
|
@property(nonatomic, assign, readonly) const firebase::firestore::model::DatabaseId *databaseID;
|
|
|
|
/**
|
|
* Dispatch queue for user callbacks / events. This will often be the "Main Dispatch Queue" of the
|
|
* app but the developer can configure it to a different queue if they so choose.
|
|
*/
|
|
@property(nonatomic, strong, readonly) FSTDispatchQueue *userDispatchQueue;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|