diff options
author | Ryan Wilson <wilsonryan@google.com> | 2018-03-21 12:01:03 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-03-21 12:01:03 -0400 |
commit | 7854c5164b4440201514b5ab0d90554dd94e9455 (patch) | |
tree | b348fb1e20a78a1a6ba76ab66b6c9020d948ff97 /Firebase/Core | |
parent | 51ffae2650e35ee63a313d6fd5ed558024a72317 (diff) |
Add file I/O usage to Core documentation. (#959)
* Add file I/O usage to documentation.
* Update defaultOptions message.
* Fix grammatical error.
Diffstat (limited to 'Firebase/Core')
-rw-r--r-- | Firebase/Core/Public/FIRApp.h | 3 | ||||
-rw-r--r-- | Firebase/Core/Public/FIROptions.h | 6 |
2 files changed, 6 insertions, 3 deletions
diff --git a/Firebase/Core/Public/FIRApp.h b/Firebase/Core/Public/FIRApp.h index e0d852b..9610455 100644 --- a/Firebase/Core/Public/FIRApp.h +++ b/Firebase/Core/Public/FIRApp.h @@ -52,7 +52,8 @@ NS_SWIFT_NAME(FirebaseApp) /** * Configures a default Firebase app. Raises an exception if any configuration step fails. The * default app is named "__FIRAPP_DEFAULT". This method should be called after the app is launched - * and before using Firebase services. This method is thread safe. + * and before using Firebase services. This method is thread safe and contains synchronous file I/O + * (reading GoogleService-Info.plist from disk). */ + (void)configure; diff --git a/Firebase/Core/Public/FIROptions.h b/Firebase/Core/Public/FIROptions.h index eba0657..b4e3b3b 100644 --- a/Firebase/Core/Public/FIROptions.h +++ b/Firebase/Core/Public/FIROptions.h @@ -25,7 +25,8 @@ NS_SWIFT_NAME(FirebaseOptions) @interface FIROptions : NSObject <NSCopying> /** - * Returns the default options. + * Returns the default options. The first time this is called it synchronously reads + * GoogleService-Info.plist from disk. */ + (nullable FIROptions *)defaultOptions NS_SWIFT_NAME(defaultOptions()); @@ -109,7 +110,8 @@ NS_SWIFT_NAME(FirebaseOptions) "setters instead."); /** - * Initializes a customized instance of FIROptions from the file at the given plist file path. + * Initializes a customized instance of FIROptions from the file at the given plist file path. This + * will read the file synchronously from disk. * For example, * NSString *filePath = * [[NSBundle mainBundle] pathForResource:@"GoogleService-Info" ofType:@"plist"]; |