firebase-app/io.github.corneloaie.firebase

Package-level declarations

Types

Firebase

object Firebase

Single access point to all firebase sdks from Kotlin.

FirebaseApiNotAvailableException

typealias FirebaseApiNotAvailableException = com.google.firebase.FirebaseApiNotAvailableException

Exception that gets thrown when an operation on Firebase fails.

FirebaseApp

class FirebaseApp

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.

FirebaseException

typealias FirebaseException = com.google.firebase.FirebaseException

Exception that gets thrown when an operation on Firebase fails.

FirebaseNetworkException

typealias FirebaseNetworkException = com.google.firebase.FirebaseNetworkException

Exception that gets thrown when an operation on Firebase fails.

FirebaseOptions

data class FirebaseOptions(val applicationId: String, val apiKey: String, val databaseUrl: String? = null, val gaTrackingId: String? = null, val storageBucket: String? = null, val projectId: String? = null, val gcmSenderId: String? = null, val authDomain: String? = null)

Configurable Firebase options.

FirebaseTooManyRequestsException

typealias FirebaseTooManyRequestsException = com.google.firebase.FirebaseTooManyRequestsException

Exception that gets thrown when an operation on Firebase fails.

UnsupportedOnApple

@RequiresOptIn(message = "Not provided by the Firebase Apple SDKs: on Apple platforms this member does nothing, or fails where it must return a value (see its documentation). Opt in with @OptIn(UnsupportedOnApple::class) if that is acceptable.", level = RequiresOptIn.Level.WARNING)

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])

annotation class UnsupportedOnApple

Marks a member of the com.google.firebase layer that the Firebase Apple SDKs do not provide: on Apple platforms it does nothing (or fails, where it must return a value), as its documentation says. Like UnsupportedOnJs, the marker is on the Apple actual only, so the warning appears when code is compiled for an Apple target, in common code included; opt in with @OptIn(UnsupportedOnApple::class) where the Apple behaviour is acceptable.

UnsupportedOnJs

@RequiresOptIn(message = "Not provided by the Firebase JS SDK: on JS this member does nothing, or fails where it must return a value (see its documentation). Opt in with @OptIn(UnsupportedOnJs::class) if that is acceptable.", level = RequiresOptIn.Level.WARNING)

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])

annotation class UnsupportedOnJs

Marks a member of the com.google.firebase layer that the Firebase JS SDK does not provide: on JS it does nothing (or fails, where it must return a value), as its documentation says. The marker is on the JS actual only, so the warning appears when code is compiled for a JS target, in common code included; opt in with @OptIn(UnsupportedOnJs::class) where the JS behaviour is acceptable.

Properties

android

val FirebaseApp.android: FirebaseApp

The underlying Firebase Android SDK app.

app

val Firebase.app: FirebaseApp

Returns the default firebase app instance.

ios

val FirebaseApp.ios: FIRApp

The underlying Firebase iOS SDK app.

val FirebaseApp.js: FirebaseApp

The underlying Firebase JS SDK app.

val FirebaseApp.js: FirebaseApp

The underlying Firebase JS SDK app.

options

val Firebase.options: FirebaseOptions

Returns options of default FirebaseApp

Functions

app

fun Firebase.app(name: String): FirebaseApp

Returns a named firebase app instance.

apps

actual fun Firebase.apps(context: Any?): List<FirebaseApp>