firebase-auth/com.google.firebase.auth/FirebaseAuth

FirebaseAuth

The entry point of Firebase Authentication, mirroring com.google.firebase.auth.FirebaseAuth from the Firebase Android SDK: obtained per FirebaseApp with the static accessors (or the Firebase.auth extensions), it signs users in and out, creates accounts, handles email actions and reports the signed-in user and its token to listeners.

Not mirrored: the Activity-bound provider sign-in flows and the SDK-internal token accessors (see api/android-sdk/exclusions.txt).

actual class FirebaseAuth(source)

expect class FirebaseAuth(source)

Not mirrored: the Activity-bound provider sign-in flows and the SDK-internal token accessors (see api/android-sdk/exclusions.txt).

actual class FirebaseAuth(source)

Types

AuthStateListener

actual fun interface AuthStateListener

Listens for changes of the signed-in user.

actual fun interface AuthStateListener

Listens for changes of the signed-in user.

expect fun interface AuthStateListener

Listens for changes of the signed-in user.

actual fun interface AuthStateListener

Listens for changes of the signed-in user.

actual fun interface AuthStateListener

Listens for changes of the signed-in user.

Companion

actual object Companion

expect object Companion

actual object Companion

IdTokenListener

actual fun interface IdTokenListener

Listens for changes of the signed-in user and of its ID token.

actual fun interface IdTokenListener

Listens for changes of the signed-in user and of its ID token.

expect fun interface IdTokenListener

Listens for changes of the signed-in user and of its ID token.

actual fun interface IdTokenListener

Listens for changes of the signed-in user and of its ID token.

actual fun interface IdTokenListener

Listens for changes of the signed-in user and of its ID token.

Properties

app

actual val app: FirebaseApp

The FirebaseApp this instance belongs to.

actual val app: FirebaseApp

The FirebaseApp this instance belongs to.

expect val app: FirebaseApp

The FirebaseApp this instance belongs to.

actual val app: FirebaseApp

The FirebaseApp this instance belongs to.

actual val app: FirebaseApp

The FirebaseApp this instance belongs to.

currentUser

actual val currentUser: FirebaseUser?

The signed-in user, or null.

actual val currentUser: FirebaseUser?

The signed-in user, or null.

expect val currentUser: FirebaseUser?

The signed-in user, or null.

actual val currentUser: FirebaseUser?

The signed-in user, or null.

actual val currentUser: FirebaseUser?

The signed-in user, or null.

customAuthDomain

actual val customAuthDomain: String?

The custom auth domain used for the provider sign-in flows, or null for the project default.

actual val customAuthDomain: String?

The custom auth domain used for the provider sign-in flows, or null for the project default.

expect val customAuthDomain: String?

The custom auth domain used for the provider sign-in flows, or null for the project default.

actual val customAuthDomain: String?

The auth domain of the app's options; the JS SDK only takes it when the app is initialized.

actual val customAuthDomain: String?

The auth domain of the app's options; the JS SDK only takes it when the app is initialized.

firebaseAuthSettings

actual val firebaseAuthSettings: FirebaseAuthSettings

The settings of this instance, for tests.

actual val firebaseAuthSettings: FirebaseAuthSettings

The settings of this instance, for tests.

expect val firebaseAuthSettings: FirebaseAuthSettings

The settings of this instance, for tests.

actual val firebaseAuthSettings: FirebaseAuthSettings

The settings of this instance, for tests.

actual val firebaseAuthSettings: FirebaseAuthSettings

The settings of this instance, for tests.

ios

val ios: FIRAuth

The underlying Firebase iOS SDK object.

val js: Auth

The underlying Firebase JS SDK object.

val js: Auth

The underlying Firebase JS SDK object.

languageCode

actual val languageCode: String?

The language of the emails and SMS the SDK sends, or null for the project default.

actual val languageCode: String?

The language of the emails and SMS the SDK sends, or null for the project default.

expect val languageCode: String?

The language of the emails and SMS the SDK sends, or null for the project default.

actual val languageCode: String?

The language of the emails and SMS the SDK sends, or null for the project default.

actual val languageCode: String?

The language of the emails and SMS the SDK sends, or null for the project default.

pendingAuthResult

val pendingAuthResult: Task<AuthResult>?

Android only: the result of a provider sign-in flow interrupted by the app being recreated, or null.

tenantId

actual val tenantId: String?

The tenant of the Identity Platform project, or null for the parent project.

actual val tenantId: String?

The tenant of the Identity Platform project, or null for the parent project.

expect val tenantId: String?

The tenant of the Identity Platform project, or null for the parent project.

actual val tenantId: String?

The tenant of the Identity Platform project, or null for the parent project.

actual val tenantId: String?

The tenant of the Identity Platform project, or null for the parent project.

Functions

addAuthStateListener

actual fun addAuthStateListener(listener: FirebaseAuth.AuthStateListener)

Registers listener, called now and whenever the signed-in user changes.

actual fun addAuthStateListener(listener: FirebaseAuth.AuthStateListener)

Registers listener, called now and whenever the signed-in user changes.

expect fun addAuthStateListener(listener: FirebaseAuth.AuthStateListener)

Registers listener, called now and whenever the signed-in user changes.

actual fun addAuthStateListener(listener: FirebaseAuth.AuthStateListener)

Registers listener, called now and whenever the signed-in user changes.

actual fun addAuthStateListener(listener: FirebaseAuth.AuthStateListener)

Registers listener, called now and whenever the signed-in user changes.

addIdTokenListener

actual fun addIdTokenListener(listener: FirebaseAuth.IdTokenListener)

Registers listener, called now and whenever the signed-in user or its ID token changes.

actual fun addIdTokenListener(listener: FirebaseAuth.IdTokenListener)

Registers listener, called now and whenever the signed-in user or its ID token changes.

expect fun addIdTokenListener(listener: FirebaseAuth.IdTokenListener)

Registers listener, called now and whenever the signed-in user or its ID token changes.

actual fun addIdTokenListener(listener: FirebaseAuth.IdTokenListener)

Registers listener, called now and whenever the signed-in user or its ID token changes.

actual fun addIdTokenListener(listener: FirebaseAuth.IdTokenListener)

Registers listener, called now and whenever the signed-in user or its ID token changes.

applyActionCode

actual fun applyActionCode(code: String): Task<Nothing?>

Applies the out-of-band code of an email action.

actual fun applyActionCode(code: String): Task<Nothing?>

Applies the out-of-band code of an email action.

expect fun applyActionCode(code: String): Task<Nothing?>

Applies the out-of-band code of an email action.

actual fun applyActionCode(code: String): Task<Nothing?>

Applies the out-of-band code of an email action.

actual fun applyActionCode(code: String): Task<Nothing?>

Applies the out-of-band code of an email action.

checkActionCode

actual fun checkActionCode(code: String): Task<ActionCodeResult>

Checks the out-of-band code of an email action and completes with what it does.

actual fun checkActionCode(code: String): Task<ActionCodeResult>

Checks the out-of-band code of an email action and completes with what it does.

expect fun checkActionCode(code: String): Task<ActionCodeResult>

Checks the out-of-band code of an email action and completes with what it does.

actual fun checkActionCode(code: String): Task<ActionCodeResult>

Checks the out-of-band code of an email action and completes with what it does.

actual fun checkActionCode(code: String): Task<ActionCodeResult>

Checks the out-of-band code of an email action and completes with what it does.

confirmPasswordReset

actual fun confirmPasswordReset(code: String, newPassword: String): Task<Nothing?>

Sets newPassword with the code of a password reset email.

actual fun confirmPasswordReset(code: String, newPassword: String): Task<Nothing?>

Sets newPassword with the code of a password reset email.

expect fun confirmPasswordReset(code: String, newPassword: String): Task<Nothing?>

Sets newPassword with the code of a password reset email.

actual fun confirmPasswordReset(code: String, newPassword: String): Task<Nothing?>

Sets newPassword with the code of a password reset email.

actual fun confirmPasswordReset(code: String, newPassword: String): Task<Nothing?>

Sets newPassword with the code of a password reset email.

createUserWithEmailAndPassword

actual fun createUserWithEmailAndPassword(email: String, password: String): Task<AuthResult>

Creates an account for email with password and signs it in.

actual fun createUserWithEmailAndPassword(email: String, password: String): Task<AuthResult>

Creates an account for email with password and signs it in.

expect fun createUserWithEmailAndPassword(email: String, password: String): Task<AuthResult>

Creates an account for email with password and signs it in.

actual fun createUserWithEmailAndPassword(email: String, password: String): Task<AuthResult>

Creates an account for email with password and signs it in.

actual fun createUserWithEmailAndPassword(email: String, password: String): Task<AuthResult>

Creates an account for email with password and signs it in.

equals

open operator override fun equals(other: Any?): Boolean

fetchSignInMethodsForEmail

actual fun ~~fetchSignInMethodsForEmail~~(email: String): Task<SignInMethodQueryResult>

The sign-in methods email can use; only works with email enumeration protection disabled.

actual fun ~~fetchSignInMethodsForEmail~~(email: String): Task<SignInMethodQueryResult>

The sign-in methods email can use; only works with email enumeration protection disabled.

expect fun ~~fetchSignInMethodsForEmail~~(email: String): Task<SignInMethodQueryResult>

The sign-in methods email can use; only works with email enumeration protection disabled.

actual fun ~~fetchSignInMethodsForEmail~~(email: String): Task<SignInMethodQueryResult>

The sign-in methods email can use; only works with email enumeration protection disabled.

actual fun ~~fetchSignInMethodsForEmail~~(email: String): Task<SignInMethodQueryResult>

The sign-in methods email can use; only works with email enumeration protection disabled.

hashCode

open override fun hashCode(): Int

initializeRecaptchaConfig

actual fun initializeRecaptchaConfig(): Task<Nothing?>

Initializes the reCAPTCHA configuration, so that the first sign-in does not have to.

actual fun initializeRecaptchaConfig(): Task<Nothing?>

Initializes the reCAPTCHA configuration, so that the first sign-in does not have to.

expect fun initializeRecaptchaConfig(): Task<Nothing?>

Initializes the reCAPTCHA configuration, so that the first sign-in does not have to.

actual fun initializeRecaptchaConfig(): Task<Nothing?>

Initializes the reCAPTCHA configuration, so that the first sign-in does not have to.

actual fun initializeRecaptchaConfig(): Task<Nothing?>

Initializes the reCAPTCHA configuration, so that the first sign-in does not have to.

isSignInWithEmailLink

actual fun isSignInWithEmailLink(link: String): Boolean

Whether link is a sign-in link sent by sendSignInLinkToEmail.

actual fun isSignInWithEmailLink(link: String): Boolean

Whether link is a sign-in link sent by sendSignInLinkToEmail.

expect fun isSignInWithEmailLink(link: String): Boolean

Whether link is a sign-in link sent by sendSignInLinkToEmail.

actual fun isSignInWithEmailLink(link: String): Boolean

Whether link is a sign-in link sent by sendSignInLinkToEmail.

actual fun isSignInWithEmailLink(link: String): Boolean

Whether link is a sign-in link sent by sendSignInLinkToEmail.

removeAuthStateListener

actual fun removeAuthStateListener(listener: FirebaseAuth.AuthStateListener)

expect fun removeAuthStateListener(listener: FirebaseAuth.AuthStateListener)

actual fun removeAuthStateListener(listener: FirebaseAuth.AuthStateListener)

removeIdTokenListener

actual fun removeIdTokenListener(listener: FirebaseAuth.IdTokenListener)

expect fun removeIdTokenListener(listener: FirebaseAuth.IdTokenListener)

actual fun removeIdTokenListener(listener: FirebaseAuth.IdTokenListener)

revokeAccessToken

actual fun revokeAccessToken(token: String): Task<Nothing?>

Revokes the Sign in with Apple token of the current user.

actual fun revokeAccessToken(token: String): Task<Nothing?>

Revokes the Sign in with Apple token of the current user.

expect fun revokeAccessToken(token: String): Task<Nothing?>

Revokes the Sign in with Apple token of the current user.

actual fun revokeAccessToken(token: String): Task<Nothing?>

Revokes the Sign in with Apple token of the current user.

actual fun revokeAccessToken(token: String): Task<Nothing?>

Revokes the Sign in with Apple token of the current user.

sendPasswordResetEmail

actual fun sendPasswordResetEmail(email: String): Task<Nothing?>

Sends a password reset email to email.

actual fun sendPasswordResetEmail(email: String, actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a password reset email to email whose link follows actionCodeSettings, when given.

actual fun sendPasswordResetEmail(email: String): Task<Nothing?>

Sends a password reset email to email.

actual fun sendPasswordResetEmail(email: String, actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a password reset email to email whose link follows actionCodeSettings, when given.

expect fun sendPasswordResetEmail(email: String): Task<Nothing?>

Sends a password reset email to email.

expect fun sendPasswordResetEmail(email: String, actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a password reset email to email whose link follows actionCodeSettings, when given.

actual fun sendPasswordResetEmail(email: String): Task<Nothing?>

Sends a password reset email to email.

actual fun sendPasswordResetEmail(email: String, actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a password reset email to email whose link follows actionCodeSettings, when given.

actual fun sendPasswordResetEmail(email: String): Task<Nothing?>

Sends a password reset email to email.

actual fun sendPasswordResetEmail(email: String, actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a password reset email to email whose link follows actionCodeSettings, when given.

sendSignInLinkToEmail

actual fun sendSignInLinkToEmail(email: String, actionCodeSettings: ActionCodeSettings): Task<Nothing?>

Sends a sign-in link to email following actionCodeSettings.

actual fun sendSignInLinkToEmail(email: String, actionCodeSettings: ActionCodeSettings): Task<Nothing?>

Sends a sign-in link to email following actionCodeSettings.

expect fun sendSignInLinkToEmail(email: String, actionCodeSettings: ActionCodeSettings): Task<Nothing?>

Sends a sign-in link to email following actionCodeSettings.

actual fun sendSignInLinkToEmail(email: String, actionCodeSettings: ActionCodeSettings): Task<Nothing?>

Sends a sign-in link to email following actionCodeSettings.

actual fun sendSignInLinkToEmail(email: String, actionCodeSettings: ActionCodeSettings): Task<Nothing?>

Sends a sign-in link to email following actionCodeSettings.

setCustomAuthDomain

actual fun setCustomAuthDomain(customAuthDomain: String)

Sets customAuthDomain.

actual fun setCustomAuthDomain(customAuthDomain: String)

Sets customAuthDomain.

expect fun setCustomAuthDomain(customAuthDomain: String)

Sets customAuthDomain.

actual fun setCustomAuthDomain(customAuthDomain: String)

Sets customAuthDomain.

actual fun setCustomAuthDomain(customAuthDomain: String)

Sets customAuthDomain.

setLanguageCode

actual fun setLanguageCode(languageCode: String)

Sets languageCode; the SDK's getter is nullable and its setter is not, so, as in the Android SDK, this is not a property setter.

actual fun setLanguageCode(languageCode: String)

Sets languageCode; the SDK's getter is nullable and its setter is not, so, as in the Android SDK, this is not a property setter.

expect fun setLanguageCode(languageCode: String)

Sets languageCode; the SDK's getter is nullable and its setter is not, so, as in the Android SDK, this is not a property setter.

actual fun setLanguageCode(languageCode: String)

Sets languageCode; the SDK's getter is nullable and its setter is not, so, as in the Android SDK, this is not a property setter.

actual fun setLanguageCode(languageCode: String)

Sets languageCode; the SDK's getter is nullable and its setter is not, so, as in the Android SDK, this is not a property setter.

setTenantId

actual fun setTenantId(tenantId: String)

Sets tenantId.

actual fun setTenantId(tenantId: String)

Sets tenantId.

expect fun setTenantId(tenantId: String)

Sets tenantId.

actual fun setTenantId(tenantId: String)

Sets tenantId.

actual fun setTenantId(tenantId: String)

Sets tenantId.

signInAnonymously

actual fun signInAnonymously(): Task<AuthResult>

Signs in an anonymous user, or returns the current one.

actual fun signInAnonymously(): Task<AuthResult>

Signs in an anonymous user, or returns the current one.

expect fun signInAnonymously(): Task<AuthResult>

Signs in an anonymous user, or returns the current one.

actual fun signInAnonymously(): Task<AuthResult>

Signs in an anonymous user, or returns the current one.

actual fun signInAnonymously(): Task<AuthResult>

Signs in an anonymous user, or returns the current one.

signInWithCredential

actual fun signInWithCredential(credential: AuthCredential): Task<AuthResult>

Signs in with credential from a provider.

actual fun signInWithCredential(credential: AuthCredential): Task<AuthResult>

Signs in with credential from a provider.

expect fun signInWithCredential(credential: AuthCredential): Task<AuthResult>

Signs in with credential from a provider.

actual fun signInWithCredential(credential: AuthCredential): Task<AuthResult>

Signs in with credential from a provider.

actual fun signInWithCredential(credential: AuthCredential): Task<AuthResult>

Signs in with credential from a provider.

signInWithCustomToken

actual fun signInWithCustomToken(token: String): Task<AuthResult>

Signs in with a custom token minted by the Admin SDK.

actual fun signInWithCustomToken(token: String): Task<AuthResult>

Signs in with a custom token minted by the Admin SDK.

expect fun signInWithCustomToken(token: String): Task<AuthResult>

Signs in with a custom token minted by the Admin SDK.

actual fun signInWithCustomToken(token: String): Task<AuthResult>

Signs in with a custom token minted by the Admin SDK.

actual fun signInWithCustomToken(token: String): Task<AuthResult>

Signs in with a custom token minted by the Admin SDK.

signInWithEmailAndPassword

actual fun signInWithEmailAndPassword(email: String, password: String): Task<AuthResult>

Signs in with email and password.

actual fun signInWithEmailAndPassword(email: String, password: String): Task<AuthResult>

Signs in with email and password.

expect fun signInWithEmailAndPassword(email: String, password: String): Task<AuthResult>

Signs in with email and password.

actual fun signInWithEmailAndPassword(email: String, password: String): Task<AuthResult>

Signs in with email and password.

actual fun signInWithEmailAndPassword(email: String, password: String): Task<AuthResult>

Signs in with email and password.

signInWithEmailLink

actual fun signInWithEmailLink(email: String, link: String): Task<AuthResult>

Signs in with the sign-in link sent to email.

actual fun signInWithEmailLink(email: String, link: String): Task<AuthResult>

Signs in with the sign-in link sent to email.

expect fun signInWithEmailLink(email: String, link: String): Task<AuthResult>

Signs in with the sign-in link sent to email.

actual fun signInWithEmailLink(email: String, link: String): Task<AuthResult>

Signs in with the sign-in link sent to email.

actual fun signInWithEmailLink(email: String, link: String): Task<AuthResult>

Signs in with the sign-in link sent to email.

signOut

actual fun signOut()

Signs out the current user.

actual fun signOut()

Signs out the current user.

expect fun signOut()

Signs out the current user.

actual fun signOut()

Starts signing out; currentUser reads as null immediately, as on Android, while the JS SDK completes it asynchronously.

actual fun signOut()

Starts signing out; currentUser reads as null immediately, as on Android, while the JS SDK completes it asynchronously.

startActivityForSignInWithProvider

fun startActivityForSignInWithProvider(activity: Activity, provider: FederatedAuthProvider): Task<AuthResult>

Android only: signs in with provider through a web flow started from activity.

toString

open override fun toString(): String

updateCurrentUser

actual fun updateCurrentUser(user: FirebaseUser): Task<Nothing?>

Makes user the current user of this instance.

actual fun updateCurrentUser(user: FirebaseUser): Task<Nothing?>

Makes user the current user of this instance.

expect fun updateCurrentUser(user: FirebaseUser): Task<Nothing?>

Makes user the current user of this instance.

actual fun updateCurrentUser(user: FirebaseUser): Task<Nothing?>

Makes user the current user of this instance.

actual fun updateCurrentUser(user: FirebaseUser): Task<Nothing?>

Makes user the current user of this instance.

useAppLanguage

actual fun useAppLanguage()

Sets languageCode to the device's language.

actual fun useAppLanguage()

Sets languageCode to the device's language.

expect fun useAppLanguage()

Sets languageCode to the device's language.

actual fun useAppLanguage()

Sets languageCode to the device's language.

actual fun useAppLanguage()

Sets languageCode to the device's language.

useEmulator

actual fun useEmulator(host: String, port: Int)

Connects to the Authentication emulator at host:port; must be called before the instance is used.

actual fun useEmulator(host: String, port: Int)

Connects to the Authentication emulator at host:port; must be called before the instance is used.

expect fun useEmulator(host: String, port: Int)

Connects to the Authentication emulator at host:port; must be called before the instance is used.

actual fun useEmulator(host: String, port: Int)

Connects to the Authentication emulator at host:port; must be called before the instance is used.

actual fun useEmulator(host: String, port: Int)

Connects to the Authentication emulator at host:port; must be called before the instance is used.

verifyPasswordResetCode

actual fun verifyPasswordResetCode(code: String): Task<String>