FIRRemoteConfig_Internal.h 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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 <FirebaseRemoteConfig/FIRRemoteConfig.h>
  17. #import <FirebaseAnalyticsInterop/FIRAnalyticsInterop.h>
  18. #import "FirebaseRemoteConfig/Sources/RCNConfigSettings.h"
  19. @class FIROptions;
  20. @class RCNConfigContent;
  21. @class RCNConfigDBManager;
  22. NS_ASSUME_NONNULL_BEGIN
  23. @class RCNConfigSettings;
  24. @interface FIRRemoteConfig () {
  25. NSString *_FIRNamespace;
  26. }
  27. /// Internal settings
  28. @property(nonatomic, readonly, strong) RCNConfigSettings *settings;
  29. /// Returns the FIRRemoteConfig instance for your namespace and for the default Firebase App.
  30. /// This singleton object contains the complete set of Remote Config parameter values available to
  31. /// the app, including the Active Config and Default Config.. This object also caches values fetched
  32. /// from the Remote Config Server until they are copied to the Active Config by calling
  33. /// activateFetched. When you fetch values from the Remote Config Server using the default Firebase
  34. /// namespace service, you should use this class method to create a shared instance of the
  35. /// FIRRemoteConfig object to ensure that your app will function properly with the Remote Config
  36. /// Server and the Firebase service. This API is used internally by 2P teams.
  37. + (FIRRemoteConfig *)remoteConfigWithFIRNamespace:(NSString *)remoteConfigNamespace
  38. NS_SWIFT_NAME(remoteConfig(FIRNamespace:));
  39. /// Returns the FIRRemoteConfig instance for your namespace and for the default 3P developer's app.
  40. /// This singleton object contains the complete set of Remote Config parameter values available to
  41. /// the app, including the Active Config and Default Config. This object also caches values fetched
  42. /// from the Remote Config Server until they are copied to the Active Config by calling
  43. /// activateFetched. When you fetch values from the Remote Config Server using the default Firebase
  44. /// namespace service, you should use this class method to create a shared instance of the
  45. /// FIRRemoteConfig object to ensure that your app will function properly with the Remote Config
  46. /// Server and the Firebase service.
  47. + (FIRRemoteConfig *)remoteConfigWithFIRNamespace:(NSString *)remoteConfigNamespace
  48. app:(FIRApp *)app
  49. NS_SWIFT_NAME(remoteConfig(FIRNamespace:app:));
  50. /// Initialize a FIRRemoteConfig instance with all the required parameters directly. This exists so
  51. /// tests can create FIRRemoteConfig objects without needing FIRApp.
  52. - (instancetype)initWithAppName:(NSString *)appName
  53. FIROptions:(FIROptions *)options
  54. namespace:(NSString *)FIRNamespace
  55. DBManager:(RCNConfigDBManager *)DBManager
  56. configContent:(RCNConfigContent *)configContent
  57. analytics:(nullable id<FIRAnalyticsInterop>)analytics;
  58. @end
  59. NS_ASSUME_NONNULL_END