Google is committed to advancing racial equity for Black communities. See how.

FirebaseInstallations

public class FirebaseInstallations extends Object
implements FirebaseInstallationsApi

Entry point for Firebase installations.

The Firebase installations service:

  • provides a unique identifier for a Firebase installation
  • provides an auth token for a Firebase installation
  • provides a API to perform GDPR-compliant deletion of a Firebase installation.

Public Method Summary

Task<Void>
delete()
Call to delete this Firebase app installation from the Firebase backend.
Task<String>
getId()
Returns a globally unique identifier of this Firebase app installation.
static FirebaseInstallations
getInstance()
Returns the FirebaseInstallations initialized with the default FirebaseApp.
static FirebaseInstallations
getInstance(FirebaseApp app)
Returns the FirebaseInstallations initialized with a custom FirebaseApp.
Task<InstallationTokenResult>
getToken(boolean forceRefresh)
Returns a valid authentication token for the Firebase installation.

Inherited Method Summary

Public Methods

public Task<Void> delete ()

Call to delete this Firebase app installation from the Firebase backend. This call may cause Firebase Cloud Messaging, Firebase Remote Config, Firebase Predictions, or Firebase In-App Messaging to not function properly.

public Task<String> getId ()

Returns a globally unique identifier of this Firebase app installation. This is a url-safe base64 string of a 128-bit integer.

public static FirebaseInstallations getInstance ()

Returns the FirebaseInstallations initialized with the default FirebaseApp.

Returns

public static FirebaseInstallations getInstance (FirebaseApp app)

Returns the FirebaseInstallations initialized with a custom FirebaseApp.

Parameters
app a custom FirebaseApp
Returns

public Task<InstallationTokenResult> getToken (boolean forceRefresh)

Returns a valid authentication token for the Firebase installation. Generates a new token if one doesn't exist, is expired, or is about to expire.

Should only be called if the Firebase installation is registered.

Parameters
forceRefresh Options to get an auth token either by force refreshing or not.