firebase-auth/com.google.firebase.auth

Package-level declarations

Types

ActionCodeEmailInfo

abstract class ActionCodeEmailInfo : ActionCodeInfo

The details of an email change action: the previousEmail it reverts to, and the new email.

ActionCodeInfo

actual open class ActionCodeInfo

The details of an email action, mirroring com.google.firebase.auth.ActionCodeInfo: the email it applies to.

expect open class ActionCodeInfo

The details of an email action, mirroring com.google.firebase.auth.ActionCodeInfo: the email it applies to.

actual open class ActionCodeInfo

The details of an email action, mirroring com.google.firebase.auth.ActionCodeInfo: the email it applies to.

ActionCodeMultiFactorInfo

abstract class ActionCodeMultiFactorInfo : ActionCodeInfo

The details of a second factor revert action: the multiFactorInfo being removed.

ActionCodeResult

interface ActionCodeResult

What the out-of-band code of an email action does, mirroring com.google.firebase.auth.ActionCodeResult; from FirebaseAuth.checkActionCode.

ActionCodeSettings

actual class ActionCodeSettings

How the link of an email action behaves, mirroring com.google.firebase.auth.ActionCodeSettings: built with Builder from newBuilder or the actionCodeSettings extension.

expect class ActionCodeSettings

How the link of an email action behaves, mirroring com.google.firebase.auth.ActionCodeSettings: built with Builder from newBuilder or the actionCodeSettings extension.

actual class ActionCodeSettings

A pure Kotlin value; the platform SDKs' forms are built from it when it is used.

ActionCodeUrl

actual class ActionCodeUrl

The parts of an email action link, mirroring com.google.firebase.auth.ActionCodeUrl.

expect class ActionCodeUrl

The parts of an email action link, mirroring com.google.firebase.auth.ActionCodeUrl.

actual class ActionCodeUrl

AdditionalUserInfo

interface AdditionalUserInfo

What a provider reported about the user on sign-in, mirroring com.google.firebase.auth.AdditionalUserInfo.

AuthCredential

actual abstract class AuthCredential

A credential from an identity provider, mirroring com.google.firebase.auth.AuthCredential.

expect abstract class AuthCredential

A credential from an identity provider, mirroring com.google.firebase.auth.AuthCredential.

actual abstract class AuthCredential

AuthResult

interface AuthResult

The result of a sign-in, link or re-authentication, mirroring com.google.firebase.auth.AuthResult.

EmailAuthCredential

actual class EmailAuthCredential : AuthCredential

An email and password, or email link, credential from EmailAuthProvider.

expect class EmailAuthCredential : AuthCredential

An email and password, or email link, credential from EmailAuthProvider.

actual class EmailAuthCredential : AuthCredential

An email and password, or email link, credential from EmailAuthProvider.

EmailAuthProvider

actual class EmailAuthProvider

Email credentials, mirroring com.google.firebase.auth.EmailAuthProvider.

expect class EmailAuthProvider

Email credentials, mirroring com.google.firebase.auth.EmailAuthProvider.

actual class EmailAuthProvider

Email credentials, mirroring com.google.firebase.auth.EmailAuthProvider.

FacebookAuthCredential

actual class FacebookAuthCredential : AuthCredential

A Facebook credential from FacebookAuthProvider.

expect class FacebookAuthCredential : AuthCredential

A Facebook credential from FacebookAuthProvider.

actual class FacebookAuthCredential : AuthCredential

A Facebook credential from FacebookAuthProvider.

FacebookAuthProvider

actual class FacebookAuthProvider

Facebook credentials, mirroring com.google.firebase.auth.FacebookAuthProvider.

expect class FacebookAuthProvider

Facebook credentials, mirroring com.google.firebase.auth.FacebookAuthProvider.

actual class FacebookAuthProvider

Facebook credentials, mirroring com.google.firebase.auth.FacebookAuthProvider.

FederatedAuthProvider

actual abstract class FederatedAuthProvider

An identity provider the SDK signs in with through a web flow, mirroring com.google.firebase.auth.FederatedAuthProvider.

expect abstract class FederatedAuthProvider

An identity provider the SDK signs in with through a web flow, mirroring com.google.firebase.auth.FederatedAuthProvider.

actual abstract class FederatedAuthProvider

An identity provider the SDK signs in with through a web flow, mirroring com.google.firebase.auth.FederatedAuthProvider.

FirebaseAuth

actual class 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.

actual class FirebaseAuth

expect class FirebaseAuth

actual class FirebaseAuth

FirebaseAuthActionCodeException

actual class FirebaseAuthActionCodeException(errorCode: String, message: String) : FirebaseAuthException

The out-of-band code of an email action is invalid or expired.

expect class FirebaseAuthActionCodeException(errorCode: String, message: String) : FirebaseAuthException

The out-of-band code of an email action is invalid or expired.

actual class FirebaseAuthActionCodeException(errorCode: String, message: String) : FirebaseAuthException

The out-of-band code of an email action is invalid or expired.

FirebaseAuthEmailException

actual open class FirebaseAuthEmailException(errorCode: String, message: String) : FirebaseAuthException

An email could not be sent.

expect open class FirebaseAuthEmailException(errorCode: String, message: String) : FirebaseAuthException

An email could not be sent.

actual open class FirebaseAuthEmailException(errorCode: String, message: String) : FirebaseAuthException

An email could not be sent.

FirebaseAuthException

actual open class FirebaseAuthException(errorCode: String, message: String) : FirebaseException

An authentication failure, mirroring com.google.firebase.auth.FirebaseAuthException; the subclasses group the causes, and errorCode names the exact one with the Android SDK's ERROR_* codes on every platform.

expect open class FirebaseAuthException(errorCode: String, message: String) : FirebaseException

actual open class FirebaseAuthException(errorCode: String, message: String) : FirebaseException

FirebaseAuthInvalidCredentialsException

actual open class FirebaseAuthInvalidCredentialsException(errorCode: String, message: String) : FirebaseAuthException

The credential is malformed, expired or wrong (including a wrong password or invalid email).

expect open class FirebaseAuthInvalidCredentialsException(errorCode: String, message: String) : FirebaseAuthException

The credential is malformed, expired or wrong (including a wrong password or invalid email).

actual open class FirebaseAuthInvalidCredentialsException(errorCode: String, message: String) : FirebaseAuthException

The credential is malformed, expired or wrong (including a wrong password or invalid email).

FirebaseAuthInvalidUserException

actual class FirebaseAuthInvalidUserException(errorCode: String, message: String) : FirebaseAuthException

The user account is disabled, deleted or its token is no longer valid.

expect class FirebaseAuthInvalidUserException(errorCode: String, message: String) : FirebaseAuthException

The user account is disabled, deleted or its token is no longer valid.

actual class FirebaseAuthInvalidUserException(errorCode: String, message: String) : FirebaseAuthException

The user account is disabled, deleted or its token is no longer valid.

FirebaseAuthMissingActivityForRecaptchaException

actual open class FirebaseAuthMissingActivityForRecaptchaException : FirebaseAuthException

Phone verification needs an Activity on Android.

expect open class FirebaseAuthMissingActivityForRecaptchaException : FirebaseAuthException

Phone verification needs an Activity on Android.

actual open class FirebaseAuthMissingActivityForRecaptchaException : FirebaseAuthException

Phone verification needs an Activity on Android.

FirebaseAuthMultiFactorException

actual open class FirebaseAuthMultiFactorException(errorCode: String, message: String, resolver: MultiFactorResolver) : FirebaseAuthException

The sign-in requires a second factor; complete it with resolver.

expect open class FirebaseAuthMultiFactorException(errorCode: String, message: String, resolver: MultiFactorResolver) : FirebaseAuthException

The sign-in requires a second factor; complete it with resolver.

actual open class FirebaseAuthMultiFactorException(errorCode: String, message: String, resolver: MultiFactorResolver) : FirebaseAuthException

The sign-in requires a second factor; complete it with resolver.

FirebaseAuthPasswordDoesNotMeetRequirementsException

actual class FirebaseAuthPasswordDoesNotMeetRequirementsException(errorCode: String, message: String, reason: String) : FirebaseAuthException

The password does not meet the project's password policy; reason says which requirements it misses.

expect class FirebaseAuthPasswordDoesNotMeetRequirementsException(errorCode: String, message: String, reason: String) : FirebaseAuthException

The password does not meet the project's password policy; reason says which requirements it misses.

actual class FirebaseAuthPasswordDoesNotMeetRequirementsException(errorCode: String, message: String, reason: String) : FirebaseAuthException

The password does not meet the project's password policy; reason says which requirements it misses.

FirebaseAuthProvider

interface FirebaseAuthProvider

Provider id of Firebase itself, mirroring com.google.firebase.auth.FirebaseAuthProvider.

FirebaseAuthRecentLoginRequiredException

actual class FirebaseAuthRecentLoginRequiredException(errorCode: String, message: String) : FirebaseAuthException

The operation requires a recent sign-in; FirebaseUser.reauthenticate first.

expect class FirebaseAuthRecentLoginRequiredException(errorCode: String, message: String) : FirebaseAuthException

The operation requires a recent sign-in; FirebaseUser.reauthenticate first.

actual class FirebaseAuthRecentLoginRequiredException(errorCode: String, message: String) : FirebaseAuthException

The operation requires a recent sign-in; FirebaseUser.reauthenticate first.

FirebaseAuthSettings

actual abstract class FirebaseAuthSettings

Test settings of a FirebaseAuth instance, mirroring com.google.firebase.auth.FirebaseAuthSettings.

expect abstract class FirebaseAuthSettings

Test settings of a FirebaseAuth instance, mirroring com.google.firebase.auth.FirebaseAuthSettings.

actual abstract class FirebaseAuthSettings

Test settings of a FirebaseAuth instance, mirroring com.google.firebase.auth.FirebaseAuthSettings.

FirebaseAuthUserCollisionException

actual class FirebaseAuthUserCollisionException(errorCode: String, message: String) : FirebaseAuthException

The email or credential is already used by another account.

expect class FirebaseAuthUserCollisionException(errorCode: String, message: String) : FirebaseAuthException

The email or credential is already used by another account.

actual class FirebaseAuthUserCollisionException(errorCode: String, message: String) : FirebaseAuthException

The email or credential is already used by another account.

FirebaseAuthWeakPasswordException

actual class FirebaseAuthWeakPasswordException(errorCode: String, message: String, reason: String?) : FirebaseAuthInvalidCredentialsException

The password does not meet the project's policy; reason says why.

expect class FirebaseAuthWeakPasswordException(errorCode: String, message: String, reason: String?) : FirebaseAuthInvalidCredentialsException

The password does not meet the project's policy; reason says why.

actual class FirebaseAuthWeakPasswordException(errorCode: String, message: String, reason: String?) : FirebaseAuthInvalidCredentialsException

The password does not meet the project's policy; reason says why.

FirebaseAuthWebException

actual open class FirebaseAuthWebException(errorCode: String, message: String) : FirebaseAuthException

A web sign-in flow failed or was cancelled.

expect open class FirebaseAuthWebException(errorCode: String, message: String) : FirebaseAuthException

A web sign-in flow failed or was cancelled.

actual open class FirebaseAuthWebException(errorCode: String, message: String) : FirebaseAuthException

A web sign-in flow failed or was cancelled.

FirebaseUser

actual abstract class FirebaseUser : UserInfo

A signed-in user, mirroring com.google.firebase.auth.FirebaseUser from the Firebase Android SDK: its profile and provider data, and the account operations that need a signed-in user.

actual abstract class FirebaseUser : UserInfo

expect abstract class FirebaseUser : UserInfo

A signed-in user, mirroring com.google.firebase.auth.FirebaseUser from the Firebase Android SDK: its profile and provider data, and the account operations that need a signed-in user.

actual abstract class FirebaseUser : UserInfo

FirebaseUserMetadata

interface FirebaseUserMetadata

When an account was created and last signed in, mirroring com.google.firebase.auth.FirebaseUserMetadata.

GetTokenResult

class GetTokenResult(val token: String?, val claims: Map<String, Any?>)

An ID token and its claims, mirroring com.google.firebase.auth.GetTokenResult.

GithubAuthCredential

actual class GithubAuthCredential : AuthCredential

A GitHub credential from GithubAuthProvider.

expect class GithubAuthCredential : AuthCredential

A GitHub credential from GithubAuthProvider.

actual class GithubAuthCredential : AuthCredential

A GitHub credential from GithubAuthProvider.

GithubAuthProvider

actual class GithubAuthProvider

GitHub credentials, mirroring com.google.firebase.auth.GithubAuthProvider.

expect class GithubAuthProvider

GitHub credentials, mirroring com.google.firebase.auth.GithubAuthProvider.

actual class GithubAuthProvider

GitHub credentials, mirroring com.google.firebase.auth.GithubAuthProvider.

GoogleAuthCredential

actual class GoogleAuthCredential : AuthCredential

A Google credential from GoogleAuthProvider.

expect class GoogleAuthCredential : AuthCredential

A Google credential from GoogleAuthProvider.

actual class GoogleAuthCredential : AuthCredential

A Google credential from GoogleAuthProvider.

GoogleAuthProvider

actual class GoogleAuthProvider

Google credentials, mirroring com.google.firebase.auth.GoogleAuthProvider.

expect class GoogleAuthProvider

Google credentials, mirroring com.google.firebase.auth.GoogleAuthProvider.

actual class GoogleAuthProvider

Google credentials, mirroring com.google.firebase.auth.GoogleAuthProvider.

MultiFactor

actual abstract class MultiFactor

The multi-factor enrollment of a user, mirroring com.google.firebase.auth.MultiFactor: enrolls a second factor from a MultiFactorAssertion and lists or removes the enrolled ones.

expect abstract class MultiFactor

The multi-factor enrollment of a user, mirroring com.google.firebase.auth.MultiFactor: enrolls a second factor from a MultiFactorAssertion and lists or removes the enrolled ones.

actual abstract class MultiFactor

The multi-factor enrollment of a user, mirroring com.google.firebase.auth.MultiFactor: enrolls a second factor from a MultiFactorAssertion and lists or removes the enrolled ones.

MultiFactorAssertion

actual abstract class MultiFactorAssertion

A verified second factor to enroll or sign in with, mirroring com.google.firebase.auth.MultiFactorAssertion.

expect abstract class MultiFactorAssertion

A verified second factor to enroll or sign in with, mirroring com.google.firebase.auth.MultiFactorAssertion.

actual abstract class MultiFactorAssertion

MultiFactorInfo

actual abstract class MultiFactorInfo

An enrolled second factor, mirroring com.google.firebase.auth.MultiFactorInfo. Its JSON form is Android-only.

expect abstract class MultiFactorInfo

An enrolled second factor, mirroring com.google.firebase.auth.MultiFactorInfo. Its JSON form is Android-only.

actual abstract class MultiFactorInfo

MultiFactorResolver

actual abstract class MultiFactorResolver

Completes a sign-in that requires a second factor, mirroring com.google.firebase.auth.MultiFactorResolver; from FirebaseAuthMultiFactorException.resolver.

expect abstract class MultiFactorResolver

Completes a sign-in that requires a second factor, mirroring com.google.firebase.auth.MultiFactorResolver; from FirebaseAuthMultiFactorException.resolver.

actual abstract class MultiFactorResolver

Completes a sign-in that requires a second factor, mirroring com.google.firebase.auth.MultiFactorResolver; from FirebaseAuthMultiFactorException.resolver.

MultiFactorSession

actual abstract class MultiFactorSession

A session for enrolling a second factor or signing in with one, mirroring com.google.firebase.auth.MultiFactorSession.

expect abstract class MultiFactorSession

A session for enrolling a second factor or signing in with one, mirroring com.google.firebase.auth.MultiFactorSession.

actual abstract class MultiFactorSession

A session for enrolling a second factor or signing in with one, mirroring com.google.firebase.auth.MultiFactorSession.

OAuthCredential

actual abstract class OAuthCredential : AuthCredential

A credential of a generic OAuth provider, mirroring com.google.firebase.auth.OAuthCredential.

expect abstract class OAuthCredential : AuthCredential

A credential of a generic OAuth provider, mirroring com.google.firebase.auth.OAuthCredential.

actual abstract class OAuthCredential : AuthCredential

A credential of a generic OAuth provider, mirroring com.google.firebase.auth.OAuthCredential.

OAuthProvider

actual class OAuthProvider : FederatedAuthProvider

A generic OAuth provider (Microsoft, Apple, Yahoo, or any OpenID Connect provider), mirroring com.google.firebase.auth.OAuthProvider: built with Builder or the oAuthProvider extension, its credentials with CredentialBuilder or the oAuthCredential extension.

expect class OAuthProvider : FederatedAuthProvider

actual class OAuthProvider : FederatedAuthProvider

A pure Kotlin value; the platform SDK's provider is built from it when it is used.

PhoneAuthCredential

actual class PhoneAuthCredential : AuthCredential

A phone number credential from PhoneAuthProvider, mirroring com.google.firebase.auth.PhoneAuthCredential.

expect class PhoneAuthCredential : AuthCredential

A phone number credential from PhoneAuthProvider, mirroring com.google.firebase.auth.PhoneAuthCredential.

actual class PhoneAuthCredential : AuthCredential

A phone number credential from PhoneAuthProvider, mirroring com.google.firebase.auth.PhoneAuthCredential.

PhoneAuthOptions

actual class PhoneAuthOptions

The options of a phone number verification, mirroring com.google.firebase.auth.PhoneAuthOptions; built with Builder. The Android SDK also takes the Activity the verification is attached to and the auto-retrieval timeout.

expect class PhoneAuthOptions

actual class PhoneAuthOptions

A pure Kotlin value.

PhoneAuthProvider

actual class PhoneAuthProvider

Phone number sign-in, mirroring com.google.firebase.auth.PhoneAuthProvider: verifyPhoneNumber sends an SMS code and reports to the PhoneAuthOptions callbacks; getCredential turns the verification id and the code the user entered into a credential.

expect class PhoneAuthProvider

actual class PhoneAuthProvider

PhoneMultiFactorAssertion

actual class PhoneMultiFactorAssertion(credential: PhoneAuthCredential) : MultiFactorAssertion

A verified phone factor, mirroring com.google.firebase.auth.PhoneMultiFactorAssertion.

expect class PhoneMultiFactorAssertion(credential: PhoneAuthCredential) : MultiFactorAssertion

A verified phone factor, mirroring com.google.firebase.auth.PhoneMultiFactorAssertion.

actual class PhoneMultiFactorAssertion(val credential: PhoneAuthCredential) : MultiFactorAssertion

PhoneMultiFactorGenerator

actual class PhoneMultiFactorGenerator

Creates phone factor assertions, mirroring com.google.firebase.auth.PhoneMultiFactorGenerator.

expect class PhoneMultiFactorGenerator

Creates phone factor assertions, mirroring com.google.firebase.auth.PhoneMultiFactorGenerator.

actual class PhoneMultiFactorGenerator

Creates phone factor assertions, mirroring com.google.firebase.auth.PhoneMultiFactorGenerator.

PhoneMultiFactorInfo

actual class PhoneMultiFactorInfo(uid: String, displayName: String?, enrollmentTimestamp: Long, phoneNumber: String) : MultiFactorInfo

An enrolled phone factor, mirroring com.google.firebase.auth.PhoneMultiFactorInfo.

expect class PhoneMultiFactorInfo(uid: String, displayName: String?, enrollmentTimestamp: Long, phoneNumber: String) : MultiFactorInfo

An enrolled phone factor, mirroring com.google.firebase.auth.PhoneMultiFactorInfo.

actual class PhoneMultiFactorInfo(val uid: String, val displayName: String?, val enrollmentTimestamp: Long, val phoneNumber: String) : MultiFactorInfo

An enrolled phone factor, mirroring com.google.firebase.auth.PhoneMultiFactorInfo.

PlayGamesAuthCredential

actual class PlayGamesAuthCredential : AuthCredential

A Google Play Games credential from PlayGamesAuthProvider, mirroring com.google.firebase.auth.PlayGamesAuthCredential. Play Games sign-in exists only on Android, so there is no such credential on the other platforms.

expect class PlayGamesAuthCredential : AuthCredential

actual class PlayGamesAuthCredential : AuthCredential

Never created on these platforms: their SDKs have no Play Games sign-in, so PlayGamesAuthProvider.getCredential fails.

PlayGamesAuthProvider

actual class PlayGamesAuthProvider

Google Play Games credentials, mirroring com.google.firebase.auth.PlayGamesAuthProvider. Play Games sign-in exists only on Android: the Apple and JS SDKs have no Play Games provider, so getCredential fails there.

actual class PlayGamesAuthProvider

expect class PlayGamesAuthProvider

actual class PlayGamesAuthProvider

SignInMethodQueryResult

interface SignInMethodQueryResult

The result of FirebaseAuth.fetchSignInMethodsForEmail, mirroring com.google.firebase.auth.SignInMethodQueryResult.

TotpMultiFactorAssertion

actual class TotpMultiFactorAssertion(oneTimePassword: String, secret: TotpSecret?, enrollmentId: String?) : MultiFactorAssertion

A verified TOTP factor, mirroring com.google.firebase.auth.TotpMultiFactorAssertion; usually created with TotpMultiFactorGenerator.getAssertionForEnrollment or TotpMultiFactorGenerator.getAssertionForSignIn, which call this constructor with the secret or the enrollmentId respectively.

expect class TotpMultiFactorAssertion(oneTimePassword: String, secret: TotpSecret?, enrollmentId: String?) : MultiFactorAssertion

actual class TotpMultiFactorAssertion(oneTimePassword: String, secret: TotpSecret?, enrollmentId: String?) : MultiFactorAssertion

The platform SDKs only create TOTP assertions through their generators, so the SDK's assertion is made when this one is first used: for enrolling secret when it is set, otherwise for signing in with enrollmentId.

TotpMultiFactorGenerator

actual class TotpMultiFactorGenerator

Creates TOTP factor secrets and assertions, mirroring com.google.firebase.auth.TotpMultiFactorGenerator.

expect class TotpMultiFactorGenerator

Creates TOTP factor secrets and assertions, mirroring com.google.firebase.auth.TotpMultiFactorGenerator.

actual class TotpMultiFactorGenerator

Creates TOTP factor secrets and assertions, mirroring com.google.firebase.auth.TotpMultiFactorGenerator.

TotpMultiFactorInfo

actual class TotpMultiFactorInfo : MultiFactorInfo

An enrolled TOTP (authenticator app) factor, mirroring com.google.firebase.auth.TotpMultiFactorInfo.

expect class TotpMultiFactorInfo : MultiFactorInfo

An enrolled TOTP (authenticator app) factor, mirroring com.google.firebase.auth.TotpMultiFactorInfo.

actual class TotpMultiFactorInfo : MultiFactorInfo

An enrolled TOTP (authenticator app) factor, mirroring com.google.firebase.auth.TotpMultiFactorInfo.

TotpSecret

actual interface TotpSecret

A TOTP secret to enroll an authenticator app with, mirroring com.google.firebase.auth.TotpSecret.

actual interface TotpSecret

The iOS SDK's FIRTOTPSecret exposes the shared secret, the QR code URL and the OTP app hand-off only: the hash algorithm and the code length are read from the QR code URL, and the other parameters throw. The iOS SDK provides TOTP on iOS only; on tvOS no secret can be generated.

expect interface TotpSecret

A TOTP secret to enroll an authenticator app with, mirroring com.google.firebase.auth.TotpSecret.

actual interface TotpSecret

The JS SDK's TotpSecret has every parameter but the session, which it keeps private.

actual interface TotpSecret

The JS SDK's TotpSecret has every parameter but the session, which it keeps private.

TwitterAuthCredential

actual class TwitterAuthCredential : AuthCredential

A Twitter credential from TwitterAuthProvider.

expect class TwitterAuthCredential : AuthCredential

A Twitter credential from TwitterAuthProvider.

actual class TwitterAuthCredential : AuthCredential

A Twitter credential from TwitterAuthProvider.

TwitterAuthProvider

actual class TwitterAuthProvider

Twitter credentials, mirroring com.google.firebase.auth.TwitterAuthProvider.

expect class TwitterAuthProvider

Twitter credentials, mirroring com.google.firebase.auth.TwitterAuthProvider.

actual class TwitterAuthProvider

Twitter credentials, mirroring com.google.firebase.auth.TwitterAuthProvider.

UserInfo

actual interface UserInfo

The profile of a user from one provider, mirroring com.google.firebase.auth.UserInfo. The photo URL is Android-only.

expect interface UserInfo

The profile of a user from one provider, mirroring com.google.firebase.auth.UserInfo. The photo URL is Android-only.

actual interface UserInfo

The profile of a user from one provider, mirroring com.google.firebase.auth.UserInfo. The photo URL is Android-only.

UserProfileChangeRequest

actual class UserProfileChangeRequest

A profile update, mirroring com.google.firebase.auth.UserProfileChangeRequest; built with Builder or the userProfileChangeRequest extension. The photo URI is Android-only.

expect class UserProfileChangeRequest

A profile update, mirroring com.google.firebase.auth.UserProfileChangeRequest; built with Builder or the userProfileChangeRequest extension. The photo URI is Android-only.

actual class UserProfileChangeRequest

A pure Kotlin value: only the fields that were set are updated.

Properties

auth

val Firebase.auth: FirebaseAuth

The FirebaseAuth of the default FirebaseApp; the Android SDK's Firebase.auth.

ios

val AuthCredential.ios: FIRAuthCredential

The iOS SDK's credential behind a credential of the layer.

val AuthCredential.js: AuthCredential

The JS SDK's credential behind a credential of the layer.

val AuthCredential.js: AuthCredential

The JS SDK's credential behind a credential of the layer.

Functions

actionCodeSettings

fun actionCodeSettings(init: ActionCodeSettings.Builder.() -> Unit): ActionCodeSettings

ActionCodeSettings built with init, as the Android SDK's actionCodeSettings.

auth

fun Firebase.auth(app: FirebaseApp): FirebaseAuth

The FirebaseAuth of app.

oAuthCredential

fun oAuthCredential(providerId: String, init: OAuthProvider.CredentialBuilder.() -> Unit): AuthCredential

An OAuth AuthCredential for providerId built with init, as the Android SDK's oAuthCredential.

oAuthProvider

fun oAuthProvider(providerId: String, init: OAuthProvider.Builder.() -> Unit): OAuthProvider

An OAuthProvider for providerId built with init, as the Android SDK's oAuthProvider.

fun oAuthProvider(providerId: String, firebaseAuth: FirebaseAuth, init: OAuthProvider.Builder.() -> Unit): OAuthProvider

An OAuthProvider for providerId and firebaseAuth built with init, as the Android SDK's oAuthProvider.

setApplicationVerifier

fun PhoneAuthOptions.Builder.setApplicationVerifier(verifier: ApplicationVerifier): PhoneAuthOptions.Builder

Sets the reCAPTCHA (or other ApplicationVerifier) of the verification; the JS SDK requires one in browsers.

fun PhoneAuthOptions.Builder.setApplicationVerifier(verifier: ApplicationVerifier): PhoneAuthOptions.Builder

Sets the reCAPTCHA (or other ApplicationVerifier) of the verification; the JS SDK requires one in browsers.

setUIDelegate

fun PhoneAuthOptions.Builder.setUIDelegate(delegate: FIRAuthUIDelegateProtocol?): PhoneAuthOptions.Builder

Sets the delegate that presents the reCAPTCHA of the verification when the SDK needs one; the default presents it over the key window.

userProfileChangeRequest

fun userProfileChangeRequest(init: UserProfileChangeRequest.Builder.() -> Unit): UserProfileChangeRequest

A UserProfileChangeRequest built with init, as the Android SDK's userProfileChangeRequest.