firebase-installations/io.github.corneloaie.firebase.installations/FirebaseInstallations

FirebaseInstallations

class FirebaseInstallations(source)

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.

Properties

val FirebaseInstallations.android: FirebaseInstallations

The underlying Firebase Android SDK object.

val compat: FirebaseInstallations

The Android-SDK-shaped com.google.firebase.installations.FirebaseInstallations this wraps.

val FirebaseInstallations.ios: FIRInstallations

The underlying Firebase iOS SDK object.

val FirebaseInstallations.js: Installations

The underlying Firebase JS SDK object.

val FirebaseInstallations.js: Installations

The underlying Firebase JS SDK object.

Functions

suspend fun delete()

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

suspend fun getId(): String

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

suspend fun getToken(forceRefresh: Boolean): String

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.