| 1 |
efrain |
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 <FirebaseCore/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 FirebaseOptions 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 |
NS_DESIGNATED_INITIALIZER;
|
|
|
56 |
|
|
|
57 |
/**
|
|
|
58 |
* `defaultOptions` and `defaultOptionsDictionary` are exposed in order to be used in FirebaseApp
|
|
|
59 |
* and other first party services.
|
|
|
60 |
*/
|
|
|
61 |
+ (FIROptions *)defaultOptions;
|
|
|
62 |
|
|
|
63 |
+ (NSDictionary *)defaultOptionsDictionary;
|
|
|
64 |
|
|
|
65 |
/**
|
|
|
66 |
* Indicates whether or not Analytics collection was explicitly enabled via a plist flag or at
|
|
|
67 |
* runtime.
|
|
|
68 |
*/
|
|
|
69 |
@property(nonatomic, readonly) BOOL isAnalyticsCollectionExplicitlySet;
|
|
|
70 |
|
|
|
71 |
/**
|
|
|
72 |
* Whether or not Analytics Collection was enabled. Analytics Collection is enabled unless
|
|
|
73 |
* explicitly disabled in GoogleService-Info.plist.
|
|
|
74 |
*/
|
|
|
75 |
@property(nonatomic, readonly) BOOL isAnalyticsCollectionEnabled;
|
|
|
76 |
|
|
|
77 |
/**
|
|
|
78 |
* Whether or not Analytics Collection was completely disabled. If true, then
|
|
|
79 |
* isAnalyticsCollectionEnabled will be false.
|
|
|
80 |
*/
|
|
|
81 |
@property(nonatomic, readonly) BOOL isAnalyticsCollectionDeactivated;
|
|
|
82 |
|
|
|
83 |
/**
|
|
|
84 |
* The version ID of the client library, e.g. @"1100000".
|
|
|
85 |
*/
|
|
|
86 |
@property(nonatomic, readonly, copy) NSString *libraryVersionID;
|
|
|
87 |
|
|
|
88 |
/**
|
|
|
89 |
* The flag indicating whether this object was constructed with the values in the default plist
|
|
|
90 |
* file.
|
|
|
91 |
*/
|
|
|
92 |
@property(nonatomic) BOOL usingOptionsFromDefaultPlist;
|
|
|
93 |
|
|
|
94 |
/**
|
|
|
95 |
* Whether or not Measurement was enabled. Measurement is enabled unless explicitly disabled in
|
|
|
96 |
* GoogleService-Info.plist.
|
|
|
97 |
*/
|
|
|
98 |
@property(nonatomic, readonly) BOOL isMeasurementEnabled;
|
|
|
99 |
|
|
|
100 |
/**
|
|
|
101 |
* Whether or not Analytics was enabled in the developer console.
|
|
|
102 |
*/
|
|
|
103 |
@property(nonatomic, readonly) BOOL isAnalyticsEnabled;
|
|
|
104 |
|
|
|
105 |
/**
|
|
|
106 |
* Whether or not SignIn was enabled in the developer console.
|
|
|
107 |
*/
|
|
|
108 |
@property(nonatomic, readonly) BOOL isSignInEnabled;
|
|
|
109 |
|
|
|
110 |
/**
|
|
|
111 |
* Whether or not editing is locked. This should occur after `FirebaseOptions` has been set on a
|
|
|
112 |
* `FirebaseApp`.
|
|
|
113 |
*/
|
|
|
114 |
@property(nonatomic, getter=isEditingLocked) BOOL editingLocked;
|
|
|
115 |
|
|
|
116 |
@end
|