firebase-auth/com.google.firebase.auth/FirebaseUser

FirebaseUser

actual abstract class FirebaseUser : UserInfo(source)

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.

Not mirrored: the Activity-bound provider flows and the photo URL, an Android Uri (see api/android-sdk/exclusions.txt).

actual abstract class FirebaseUser : UserInfo(source)

expect abstract class FirebaseUser : UserInfo(source)

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.

Not mirrored: the Activity-bound provider flows and the photo URL, an Android Uri (see api/android-sdk/exclusions.txt).

actual abstract class FirebaseUser : UserInfo(source)

actual abstract class FirebaseUser : UserInfo(source)

Constructors

actual constructor()

actual constructor()

expect constructor()

actual constructor()

actual constructor()

Properties

actual abstract val displayName: String?

actual abstract val displayName: String?

expect abstract val displayName: String?

actual abstract val displayName: String?

actual abstract val displayName: String?

actual abstract val email: String?

actual abstract val email: String?

expect abstract val email: String?

actual abstract val email: String?

actual abstract val email: String?

abstract val ios: FIRUser

The underlying Firebase iOS SDK object.

actual abstract val isAnonymous: Boolean

Whether the user signed in anonymously.

actual abstract val isAnonymous: Boolean

Whether the user signed in anonymously.

expect abstract val isAnonymous: Boolean

Whether the user signed in anonymously.

actual abstract val isAnonymous: Boolean

Whether the user signed in anonymously.

actual abstract val isAnonymous: Boolean

Whether the user signed in anonymously.

isEmailVerified

actual abstract val isEmailVerified: Boolean

actual abstract val isEmailVerified: Boolean

expect abstract val isEmailVerified: Boolean

actual abstract val isEmailVerified: Boolean

actual abstract val isEmailVerified: Boolean

abstract val js: User

The underlying Firebase JS SDK object.

abstract val js: User

The underlying Firebase JS SDK object.

actual abstract val metadata: FirebaseUserMetadata?

When the account was created and last signed in, or null when unknown.

actual abstract val metadata: FirebaseUserMetadata?

When the account was created and last signed in, or null when unknown.

expect abstract val metadata: FirebaseUserMetadata?

When the account was created and last signed in, or null when unknown.

actual abstract val metadata: FirebaseUserMetadata?

When the account was created and last signed in, or null when unknown.

actual abstract val metadata: FirebaseUserMetadata?

When the account was created and last signed in, or null when unknown.

actual abstract val multiFactor: MultiFactor

The multi-factor enrollment of the user.

actual abstract val multiFactor: MultiFactor

The multi-factor enrollment of the user.

expect abstract val multiFactor: MultiFactor

The multi-factor enrollment of the user.

actual abstract val multiFactor: MultiFactor

The multi-factor enrollment of the user.

actual abstract val multiFactor: MultiFactor

The multi-factor enrollment of the user.

actual abstract val phoneNumber: String?

actual abstract val phoneNumber: String?

expect abstract val phoneNumber: String?

actual abstract val phoneNumber: String?

actual abstract val phoneNumber: String?

abstract val photoUrl: Uri?

Android only: the profile photo as a Uri.

abstract val photoUrl: String?

The profile photo URL.

abstract val photoUrl: String?

The profile photo URL.

abstract val photoUrl: String?

The profile photo URL.

actual abstract val providerData: List<UserInfo>

The profile of the user from each linked provider.

actual abstract val providerData: List<UserInfo>

The profile of the user from each linked provider.

expect abstract val providerData: List<UserInfo>

The profile of the user from each linked provider.

actual abstract val providerData: List<UserInfo>

The profile of the user from each linked provider.

actual abstract val providerData: List<UserInfo>

The profile of the user from each linked provider.

actual abstract val providerId: String

actual abstract val providerId: String

expect abstract val providerId: String

actual abstract val providerId: String

actual abstract val providerId: String

actual abstract val tenantId: String?

The tenant the user signed in to, or null.

actual abstract val tenantId: String?

The tenant the user signed in to, or null.

expect abstract val tenantId: String?

The tenant the user signed in to, or null.

actual abstract val tenantId: String?

The tenant the user signed in to, or null.

actual abstract val tenantId: String?

The tenant the user signed in to, or null.

actual abstract val uid: String

actual abstract val uid: String

expect abstract val uid: String

actual abstract val uid: String

actual abstract val uid: String

Functions

actual fun delete(): Task<Nothing?>

Deletes the account; requires a recent sign-in.

actual fun delete(): Task<Nothing?>

Deletes the account; requires a recent sign-in.

expect fun delete(): Task<Nothing?>

Deletes the account; requires a recent sign-in.

actual fun delete(): Task<Nothing?>

Deletes the account; requires a recent sign-in.

actual fun delete(): Task<Nothing?>

Deletes the account; requires a recent sign-in.

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

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

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

actual fun getIdToken(forceRefresh: Boolean): Task<GetTokenResult>

The ID token of the user, refreshed when forceRefresh.

actual fun getIdToken(forceRefresh: Boolean): Task<GetTokenResult>

The ID token of the user, refreshed when forceRefresh.

expect fun getIdToken(forceRefresh: Boolean): Task<GetTokenResult>

The ID token of the user, refreshed when forceRefresh.

actual fun getIdToken(forceRefresh: Boolean): Task<GetTokenResult>

The ID token of the user, refreshed when forceRefresh.

actual fun getIdToken(forceRefresh: Boolean): Task<GetTokenResult>

The ID token of the user, refreshed when forceRefresh.

open override fun hashCode(): Int

open override fun hashCode(): Int

open override fun hashCode(): Int

linkWithCredential

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

Links credential to the account.

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

Links credential to the account.

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

Links credential to the account.

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

Links credential to the account.

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

Links credential to the account.

actual fun reauthenticate(credential: AuthCredential): Task<Nothing?>

Re-authenticates with credential, for the operations that require a recent sign-in.

actual fun reauthenticate(credential: AuthCredential): Task<Nothing?>

Re-authenticates with credential, for the operations that require a recent sign-in.

expect fun reauthenticate(credential: AuthCredential): Task<Nothing?>

Re-authenticates with credential, for the operations that require a recent sign-in.

actual fun reauthenticate(credential: AuthCredential): Task<Nothing?>

Re-authenticates with credential, for the operations that require a recent sign-in.

actual fun reauthenticate(credential: AuthCredential): Task<Nothing?>

Re-authenticates with credential, for the operations that require a recent sign-in.

reauthenticateAndRetrieveData

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

Re-authenticates with credential and completes with the result.

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

Re-authenticates with credential and completes with the result.

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

Re-authenticates with credential and completes with the result.

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

Re-authenticates with credential and completes with the result.

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

Re-authenticates with credential and completes with the result.

actual fun reload(): Task<Nothing?>

Refreshes the profile from the backend.

actual fun reload(): Task<Nothing?>

Refreshes the profile from the backend.

expect fun reload(): Task<Nothing?>

Refreshes the profile from the backend.

actual fun reload(): Task<Nothing?>

Refreshes the profile from the backend.

actual fun reload(): Task<Nothing?>

Refreshes the profile from the backend.

sendEmailVerification

actual fun sendEmailVerification(): Task<Nothing?>

Sends a verification email to the user's address.

actual fun sendEmailVerification(actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a verification email whose link follows actionCodeSettings, when given.

actual fun sendEmailVerification(): Task<Nothing?>

Sends a verification email to the user's address.

actual fun sendEmailVerification(actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a verification email whose link follows actionCodeSettings, when given.

expect fun sendEmailVerification(): Task<Nothing?>

Sends a verification email to the user's address.

expect fun sendEmailVerification(actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a verification email whose link follows actionCodeSettings, when given.

actual fun sendEmailVerification(): Task<Nothing?>

Sends a verification email to the user's address.

actual fun sendEmailVerification(actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a verification email whose link follows actionCodeSettings, when given.

actual fun sendEmailVerification(): Task<Nothing?>

Sends a verification email to the user's address.

actual fun sendEmailVerification(actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a verification email whose link follows actionCodeSettings, when given.

startActivityForLinkWithProvider

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

Android only: links provider through a web flow started from activity.

startActivityForReauthenticateWithProvider

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

Android only: re-authenticates with provider through a web flow started from activity.

open override fun toString(): String

open override fun toString(): String

open override fun toString(): String

actual fun unlink(provider: String): Task<AuthResult>

Unlinks the provider provider and completes with the updated user.

actual fun unlink(provider: String): Task<AuthResult>

Unlinks the provider provider and completes with the updated user.

expect fun unlink(provider: String): Task<AuthResult>

Unlinks the provider provider and completes with the updated user.

actual fun unlink(provider: String): Task<AuthResult>

Unlinks the provider provider and completes with the updated user.

actual fun unlink(provider: String): Task<AuthResult>

Unlinks the provider provider and completes with the updated user.

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

Sets the email address; requires a recent sign-in.

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

Sets the email address; requires a recent sign-in.

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

Sets the email address; requires a recent sign-in.

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

Sets the email address; requires a recent sign-in.

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

Sets the email address; requires a recent sign-in.

actual fun updatePassword(password: String): Task<Nothing?>

Sets the password; requires a recent sign-in.

actual fun updatePassword(password: String): Task<Nothing?>

Sets the password; requires a recent sign-in.

expect fun updatePassword(password: String): Task<Nothing?>

Sets the password; requires a recent sign-in.

actual fun updatePassword(password: String): Task<Nothing?>

Sets the password; requires a recent sign-in.

actual fun updatePassword(password: String): Task<Nothing?>

Sets the password; requires a recent sign-in.

updatePhoneNumber

actual fun updatePhoneNumber(credential: PhoneAuthCredential): Task<Nothing?>

Sets the phone number from a verified credential.

actual fun updatePhoneNumber(credential: PhoneAuthCredential): Task<Nothing?>

Sets the phone number from a verified credential.

expect fun updatePhoneNumber(credential: PhoneAuthCredential): Task<Nothing?>

Sets the phone number from a verified credential.

actual fun updatePhoneNumber(credential: PhoneAuthCredential): Task<Nothing?>

Sets the phone number from a verified credential.

actual fun updatePhoneNumber(credential: PhoneAuthCredential): Task<Nothing?>

Sets the phone number from a verified credential.

actual fun updateProfile(request: UserProfileChangeRequest): Task<Nothing?>

Applies request to the profile.

actual fun updateProfile(request: UserProfileChangeRequest): Task<Nothing?>

Applies request to the profile.

expect fun updateProfile(request: UserProfileChangeRequest): Task<Nothing?>

Applies request to the profile.

actual fun updateProfile(request: UserProfileChangeRequest): Task<Nothing?>

Applies request to the profile.

actual fun updateProfile(request: UserProfileChangeRequest): Task<Nothing?>

Applies request to the profile.

verifyBeforeUpdateEmail

actual fun verifyBeforeUpdateEmail(newEmail: String): Task<Nothing?>

Sends a verification email to newEmail, which becomes the address once verified.

actual fun verifyBeforeUpdateEmail(newEmail: String, actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a verification email to newEmail whose link follows actionCodeSettings, when given.

actual fun verifyBeforeUpdateEmail(newEmail: String): Task<Nothing?>

Sends a verification email to newEmail, which becomes the address once verified.

actual fun verifyBeforeUpdateEmail(newEmail: String, actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a verification email to newEmail whose link follows actionCodeSettings, when given.

expect fun verifyBeforeUpdateEmail(newEmail: String): Task<Nothing?>

Sends a verification email to newEmail, which becomes the address once verified.

expect fun verifyBeforeUpdateEmail(newEmail: String, actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a verification email to newEmail whose link follows actionCodeSettings, when given.

actual fun verifyBeforeUpdateEmail(newEmail: String): Task<Nothing?>

Sends a verification email to newEmail, which becomes the address once verified.

actual fun verifyBeforeUpdateEmail(newEmail: String, actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a verification email to newEmail whose link follows actionCodeSettings, when given.

actual fun verifyBeforeUpdateEmail(newEmail: String): Task<Nothing?>

Sends a verification email to newEmail, which becomes the address once verified.

actual fun verifyBeforeUpdateEmail(newEmail: String, actionCodeSettings: ActionCodeSettings?): Task<Nothing?>

Sends a verification email to newEmail whose link follows actionCodeSettings, when given.