FirebaseApp

public class FirebaseApp extends Object

The entry point of Firebase SDKs. It holds common configuration and state for Firebase APIs. Most applications don't need to directly interact with FirebaseApp.

Firebase APIs use the default FirebaseApp by default, unless a different one is explicitly passed to the API via FirebaseFoo.getInstance(firebaseApp).

initializeApp(FirebaseOptions) initializes the default app instance. This method should be invoked at startup.

Constant Summary

String DEFAULT_APP_NAME

Public Method Summary

void
delete()
Deletes the FirebaseApp and all its data.
boolean
equals(Object o)
static List<FirebaseApp>
getApps()
Returns a list of all FirebaseApps.
static FirebaseApp
getInstance(String name)
Returns the instance identified by the unique name, or throws if it does not exist.
static FirebaseApp
getInstance()
Returns the default (first initialized) instance of the FirebaseApp.
String
getName()
Returns the unique name of this app.
FirebaseOptions
getOptions()
Returns the specified FirebaseOptions.
int
static FirebaseApp
initializeApp(FirebaseOptions options, String name)
A factory method to intialize a FirebaseApp.
static FirebaseApp
initializeApp(FirebaseOptions options)
Initializes the default FirebaseApp instance.
String

Inherited Method Summary

Constants

public static final String DEFAULT_APP_NAME

Constant Value: "[DEFAULT]"

Public Methods

public void delete ()

Deletes the FirebaseApp and all its data. All calls to this FirebaseApp instance will throw once it has been called.

A no-op if delete was called before.

public boolean equals (Object o)

public static List<FirebaseApp> getApps ()

Returns a list of all FirebaseApps.

public static FirebaseApp getInstance (String name)

Returns the instance identified by the unique name, or throws if it does not exist.

Parameters
name represents the name of the FirebaseApp instance.
Returns
Throws
IllegalStateException if the FirebaseApp was not initialized, either via initializeApp(FirebaseOptions, String) or getApps().

public static FirebaseApp getInstance ()

Returns the default (first initialized) instance of the FirebaseApp.

Throws
IllegalStateException if the default app was not initialized.

public String getName ()

Returns the unique name of this app.

public FirebaseOptions getOptions ()

Returns the specified FirebaseOptions.

public int hashCode ()

public static FirebaseApp initializeApp (FirebaseOptions options, String name)

A factory method to intialize a FirebaseApp.

Parameters
options represents the global FirebaseOptions
name unique name for the app. It is an error to initialize an app with an already existing name. Starting and ending whitespace characters in the name are ignored (trimmed).
Returns
Throws
IllegalStateException if an app with the same name has already been initialized.

public static FirebaseApp initializeApp (FirebaseOptions options)

Initializes the default FirebaseApp instance. Same as initializeApp(FirebaseOptions, String), but it uses DEFAULT_APP_NAME as name. *

The creation of the default instance is automatically triggered at app startup time, if Firebase configuration values are available from resources - populated from google-services.json.

public String toString ()

Send feedback about...

Need help? Visit our support page.