iOS/Pods/FirebaseCore/Firebase/Core/Private/FIROptionsInternal.h

   1 /*
   2  * Copyright 2017 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
  17 #import "FIROptions.h"
  18
  19 /**
  20  * Keys for the strings in the plist file.
  21  */
  22 extern NSString *const kFIRAPIKey;
  23 extern NSString *const kFIRTrackingID;
  24 extern NSString *const kFIRGoogleAppID;
  25 extern NSString *const kFIRClientID;
  26 extern NSString *const kFIRGCMSenderID;
  27 extern NSString *const kFIRAndroidClientID;
  28 extern NSString *const kFIRDatabaseURL;
  29 extern NSString *const kFIRStorageBucket;
  30 extern NSString *const kFIRBundleID;
  31 extern NSString *const kFIRProjectID;
  32
  33 /**
  34  * Keys for the plist file name
  35  */
  36 extern NSString *const kServiceInfoFileName;
  37
  38 extern NSString *const kServiceInfoFileType;
  39
  40 /**
  41  * This header file exposes the initialization of FIROptions to internal use.
  42  */
  43 @interface FIROptions ()
  44
  45 /**
  46  * resetDefaultOptions and initInternalWithOptionsDictionary: are exposed only for unit tests.
  47  */
  48 + (void)resetDefaultOptions;
  49
  50 /**
  51  * Initializes the options with dictionary. The above strings are the keys of the dictionary.
  52  * This is the designated initializer.
  53  */
  54 - (instancetype)initInternalWithOptionsDictionary:(NSDictionary *)serviceInfoDictionary;
  55
  56 /**
  57  * defaultOptions and defaultOptionsDictionary are exposed in order to be used in FIRApp and
  58  * other first party services.
  59  */
  60 + (FIROptions *)defaultOptions;
  61
  62 + (NSDictionary *)defaultOptionsDictionary;
  63
  64 /**
  65  * Indicates whether or not Analytics collection was explicitly enabled via a plist flag or at
  66  * runtime.
  67  */
  68 @property(nonatomic, readonly) BOOL isAnalyticsCollectionExpicitlySet;
  69
  70 /**
  71  * Whether or not Analytics Collection was enabled. Analytics Collection is enabled unless
  72  * explicitly disabled in GoogleService-Info.plist.
  73  */
  74 @property(nonatomic, readonly) BOOL isAnalyticsCollectionEnabled;
  75
  76 /**
  77  * Whether or not Analytics Collection was completely disabled. If YES, then
  78  * isAnalyticsCollectionEnabled will be NO.
  79  */
  80 @property(nonatomic, readonly) BOOL isAnalyticsCollectionDeactivated;
  81
  82 /**
  83  * The version ID of the client library, e.g. @"1100000".
  84  */
  85 @property(nonatomic, readonly, copy) NSString *libraryVersionID;
  86
  87 /**
  88  * The flag indicating whether this object was constructed with the values in the default plist
  89  * file.
  90  */
  91 @property(nonatomic) BOOL usingOptionsFromDefaultPlist;
  92
  93 /**
  94  * Whether or not Measurement was enabled. Measurement is enabled unless explicitly disabled in
  95  * GoogleService-Info.plist.
  96  */
  97 @property(nonatomic, readonly) BOOL isMeasurementEnabled;
  98
  99 /**
 100  * Whether or not Analytics was enabled in the developer console.
 101  */
 102 @property(nonatomic, readonly) BOOL isAnalyticsEnabled;
 103
 104 /**
 105  * Whether or not SignIn was enabled in the developer console.
 106  */
 107 @property(nonatomic, readonly) BOOL isSignInEnabled;
 108
 109 /**
 110  * Whether or not editing is locked. This should occur after FIROptions has been set on a FIRApp.
 111  */
 112 @property(nonatomic, getter=isEditingLocked) BOOL editingLocked;
 113
 114 @end