FSTFirestoreComponent.h 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. /*
  2. * Copyright 2018 Google
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #import <Foundation/Foundation.h>
  17. #import "Firestore/Source/API/FIRFirestore+Internal.h"
  18. @class FIRApp;
  19. @class FIRFirestore;
  20. NS_ASSUME_NONNULL_BEGIN
  21. /// Provides and creates instances of Firestore based on a specific key. Used in the interop
  22. /// registration process to keep track of instances for `FIRApp` instances.
  23. @protocol FSTFirestoreMultiDBProvider
  24. /// Cached instances of Firestore objects.
  25. @property(nonatomic, strong) NSMutableDictionary<NSString *, FIRFirestore *> *instances;
  26. /// Default method for retrieving a Firestore instance, or creating one if it doesn't exist.
  27. - (FIRFirestore *)firestoreForDatabase:(NSString *)database;
  28. @end
  29. /// A concrete implementation for FSTInstanceProvider to create Firestore instances and register
  30. /// with Core's component system.
  31. @interface FSTFirestoreComponent
  32. : NSObject <FSTFirestoreInstanceRegistry, FSTFirestoreMultiDBProvider>
  33. /// The FIRApp that instances will be set up with.
  34. @property(nonatomic, weak, readonly) FIRApp *app;
  35. /// Cached instances of Firestore objects.
  36. @property(nonatomic, strong) NSMutableDictionary<NSString *, FIRFirestore *> *instances;
  37. /// Default method for retrieving a Firestore instance, or creating one if it doesn't exist.
  38. - (FIRFirestore *)firestoreForDatabase:(NSString *)database;
  39. - (void)removeInstanceWithDatabase:(NSString *)database;
  40. /// Default initializer.
  41. - (instancetype)initWithApp:(FIRApp *)app NS_DESIGNATED_INITIALIZER;
  42. - (instancetype)init NS_UNAVAILABLE;
  43. @end
  44. NS_ASSUME_NONNULL_END