FIRSegmentationComponent.h 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. /*
  2. * Copyright 2019 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 "FIRLibrary.h"
  18. @class FIRApp;
  19. @class FIRSegmentation;
  20. NS_ASSUME_NONNULL_BEGIN
  21. /// Provides and creates instances of Segmentation. Used in the
  22. /// interop registration process to keep track of Segmentation instances for each `FIRApp` instance.
  23. @protocol FIRSegmentationProvider
  24. /// Cached instances of Segmentation objects.
  25. @property(nonatomic, strong) NSMutableDictionary<NSString *, FIRSegmentation *> *instances;
  26. /// Default method for retrieving a Segmentation instance, or creating one if it doesn't exist.
  27. - (FIRSegmentation *)segmentation;
  28. @end
  29. /// A concrete implementation for FIRSegmentationInterop to create Segmentation instances and
  30. /// register with Core's component system.
  31. @interface FIRSegmentationComponent : NSObject <FIRSegmentationProvider, FIRLibrary>
  32. /// The FIRApp that instances will be set up with.
  33. @property(nonatomic, weak, readonly) FIRApp *app;
  34. /// Cached instances of Segmentation objects.
  35. @property(nonatomic, strong) FIRSegmentation *segmentationInstance;
  36. /// Default method for retrieving a Segmentation instance, or creating one if it doesn't exist.
  37. - (FIRSegmentation *)segmentation;
  38. /// Default initializer.
  39. - (instancetype)initWithApp:(FIRApp *)app NS_DESIGNATED_INITIALIZER;
  40. - (instancetype)init __attribute__((unavailable("Use `initWithApp:`.")));
  41. @end
  42. NS_ASSUME_NONNULL_END