firebase-installations/com.google.firebase.installations/FirebaseInstallations

FirebaseInstallations

actual class FirebaseInstallations(source)
actual class FirebaseInstallations(source)
expect class FirebaseInstallations(source)

Entry point for Firebase installations, mirroring com.google.firebase.installations.FirebaseInstallations from the Firebase Android SDK.

Not mirrored: clearFidCache (hidden in the Android SDK, no equivalent on other platforms).

actual class FirebaseInstallations(source)
actual class FirebaseInstallations(source)

Types

Link copied to clipboard
actual object Companion
actual object Companion
expect object Companion
actual object Companion
actual object Companion

Properties

Link copied to clipboard
val ios: FIRInstallations

The underlying Firebase iOS SDK object.

Link copied to clipboard
val js: Installations

The underlying Firebase JS SDK object.

Functions

Link copied to clipboard
actual fun delete(): Task<Nothing?>
actual fun delete(): Task<Nothing?>
expect fun delete(): Task<Nothing?>

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.

actual fun delete(): Task<Nothing?>
actual fun delete(): Task<Nothing?>
Link copied to clipboard
actual fun getId(): Task<String>
actual fun getId(): Task<String>
expect fun getId(): Task<String>

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

actual fun getId(): Task<String>
actual fun getId(): Task<String>
Link copied to clipboard
actual fun getToken(forceRefresh: Boolean): Task<InstallationTokenResult>
actual fun getToken(forceRefresh: Boolean): Task<InstallationTokenResult>
expect fun getToken(forceRefresh: Boolean): Task<InstallationTokenResult>

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.

actual fun getToken(forceRefresh: Boolean): Task<InstallationTokenResult>
actual fun getToken(forceRefresh: Boolean): Task<InstallationTokenResult>
Link copied to clipboard
actual fun registerFidListener(listener: FidListener): FidListenerHandle
actual fun registerFidListener(listener: FidListener): FidListenerHandle

Observes the iOS SDK's installation-id-changed notification for this app and reports the current id, which the SDK generates anew when it was deleted.

expect fun registerFidListener(listener: FidListener): FidListenerHandle

Registers a FidListener that receives the new installation id whenever it changes, for example when a new id is generated after delete. Unregister it through the returned handle.

actual fun registerFidListener(listener: FidListener): FidListenerHandle
actual fun registerFidListener(listener: FidListener): FidListenerHandle