@@ -99,25 +99,30 @@ NS_SWIFT_NAME(FirebaseOptions)
99
99
@property(nonatomic, copy, nullable) NSString *appGroupID;
100
100
101
101
/* *
102
- * Initializes a customized instance of FIROptions from the file at the given plist file path. This
103
- * will read the file synchronously from disk.
104
- * For example,
105
- * NSString *filePath =
106
- * [[NSBundle mainBundle] pathForResource:@"GoogleService-Info" ofType:@"plist"];
107
- * FIROptions *options = [[FIROptions alloc] initWithContentsOfFile:filePath];
102
+ * Initializes a customized instance of FirebaseOptions from the file at the given plist file path.
103
+ * This will read the file synchronously from disk.
104
+ * For example:
105
+ * ```swift
106
+ * if let path = Bundle.main.path(forResource:"GoogleServices-Info", ofType:"plist") {
107
+ * let options = FirebaseOptions(contentsOfFile: path)
108
+ * }
109
+ * ```
110
+ * Note that it is not possible to customize FirebaseOptions for Firebase Analytics which expects a
111
+ * static file named `GoogleServices-Info.plist` -
112
+ * https://github.com/firebase/firebase-ios-sdk/issues/230.
108
113
* Returns nil if the plist file does not exist or is invalid.
109
114
*/
110
115
- (nullable instancetype )initWithContentsOfFile:(NSString *)plistPath NS_DESIGNATED_INITIALIZER;
111
116
112
117
/* *
113
- * Initializes a customized instance of FIROptions with required fields. Use the mutable properties
114
- * to modify fields for configuring specific services.
118
+ * Initializes a customized instance of FirebaseOptions with required fields. Use the mutable
119
+ * properties to modify fields for configuring specific services. Note that it is not possible to
120
+ * customize FirebaseOptions for Firebase Analytics which expects a static file named
121
+ * `GoogleServices-Info.plist` - https://github.com/firebase/firebase-ios-sdk/issues/230.
115
122
*/
116
- // clang-format off
117
123
- (instancetype )initWithGoogleAppID:(NSString *)googleAppID
118
124
GCMSenderID:(NSString *)GCMSenderID
119
- NS_SWIFT_NAME (init(googleAppID:gcmSenderID:)) NS_DESIGNATED_INITIALIZER;
120
- // clang-format on
125
+ NS_SWIFT_NAME (init(googleAppID:gcmSenderID:))NS_DESIGNATED_INITIALIZER;
121
126
122
127
/* * Unavailable. Please use `init(contentsOfFile:)` or `init(googleAppID:gcmSenderID:)` instead. */
123
128
- (instancetype )init NS_UNAVAILABLE;
0 commit comments