FIRApp Class Reference

#import <FIRApp.h>

Inheritance diagram for FIRApp:

Instance Methods
(void)	- deleteApp:
(nullable instancetype)	- NS_UNAVAILABLE

Class Methods
(void)	+ configure
(void)	+ configureWithOptions:
(void)	+ configureWithName:options:
(defaultApp()	+ NS_SWIFT_NAME
(nullable FIRApp *)	+ appNamed:
(nullable NSDictionary *)	+ allApps

Properties
NSString *	name
FIROptions *	options

Detailed Description

The entry point of Firebase SDKs.

Initialize and configure FIRApp using [FIRApp configure]; Or other customized ways as shown below.

Method Documentation

+ (nullable NSDictionary *) allApps

Returns the set of all extant FIRApp instances, or nil if there is no FIRApp instance. This method is thread safe.

+ (nullable FIRApp *) appNamed:

(NSString *)

name

Returns a previously created FIRApp instance with the given name, or nil if no such app exists. This method is thread safe.

+ (void) configure

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.

+ (void) configureWithName:		(NSString *)	name
options:		(FIROptions *)	options

Configures a Firebase app with the given name and options. Raises an exception if any configuration step fails. This method is thread safe.

Parameters

name	The application's name given by the developer. The name should should only contain Letters, Numbers and Underscore.
options	The Firebase application options used to configure the services.

+ (void) configureWithOptions:

(FIROptions *)

options

Configures the default Firebase app with the provided options. The default app is named "__FIRAPP_DEFAULT". Raises an exception if any configuration step fails. This method is thread safe.

Parameters

options

The Firebase application options used to configure the service.

- (void) deleteApp:

(FIRAppVoidBoolCallback)

completion

Cleans up the current FIRApp, freeing associated data and returning its name to the pool for future use. This method is thread safe in class level.

+ (defaultApp() NS_SWIFT_NAME

Returns the default app, or nil if the default app does not exist.

- (nullable instancetype) NS_UNAVAILABLE

FIRFirebaseApp instances should not be initialized directly. Call |FIRApp configure|, or |FIRApp configureWithOptions:|, or |FIRApp configureWithNames:options| directly.

Property Documentation

- (NSString*) name

readnonatomiccopy

Gets the name of this app.

- (FIROptions*) options

readnonatomicassign

Gets the options for this app.

---

The documentation for this class was generated from the following file:

• Frameworks/FirebaseAnalytics.framework/Headers/FIRApp.h