FirebaseUser

public abstract class FirebaseUser extends Object
implements Parcelable UserInfo

Represents a user's profile information in your Firebase project's user database. It also contains helper methods to change or retrieve profile information, as well as to manage that user's authentication state.

Inherited Constant Summary

Public Constructor Summary

Public Method Summary

Task<Void>
delete()
Deletes the user record from your Firebase project's database.
abstract String
getDisplayName()
Returns the main display name of this user from the Firebase project's user database.
abstract String
getEmail()
Returns the main email address of the user, as stored in the Firebase project's user database.
Task<GetTokenResult>
getIdToken(boolean forceRefresh)
Fetches a Firebase Auth ID Token for the user; useful when authenticating against your own backend.
abstract FirebaseUserMetadata
getMetadata()
Returns the FirebaseUserMetadata associated with this user.
abstract String
getPhoneNumber()
Returns the phone number of the user, as stored in the Firebase project's user database, or null if none exists.
abstract Uri
getPhotoUrl()
Returns the URL of this user's main profile picture, as stored in the Firebase project's user database.
abstract List<? extends UserInfo>
getProviderData()
Returns a List of UserInfo objects that represents the linked identities of the user using different authentication providers that may be linked to their account.
abstract String
getProviderId()
Always returns PROVIDER_ID
abstract String
getUid()
Returns a string used to uniquely identify your user in your Firebase project's user database.
abstract boolean
isAnonymous()
Returns true if the user is anonymous; that is, the user account was created with signInAnonymously() and has not been linked to another account with linkWithCredential(AuthCredential).
Task<AuthResult>
linkWithCredential(AuthCredential credential)
Attaches the given AuthCredential to the user.
Task<Void>
reauthenticate(AuthCredential credential)
Reauthenticates the user with the given credential.
Task<AuthResult>
reauthenticateAndRetrieveData(AuthCredential credential)
Reauthenticates the user with the given credential, and returns the profile data for that account.
Task<Void>
reload()
Manually refreshes the data of the current user (for example, attached providers, display name, and so on).
Task<Void>
sendEmailVerification(ActionCodeSettings actionCodeSettings)
Initiates email verification for the user.
Task<Void>
Task<AuthResult>
unlink(String provider)
Detaches credentials from a given provider type from this user.
Task<Void>
updateEmail(String email)
Updates the email address of the user.
Task<Void>
updatePassword(String password)
Updates the password of the user.
Task<Void>
updatePhoneNumber(PhoneAuthCredential credential)
Updates the phone number of the user.
Task<Void>
updateProfile(UserProfileChangeRequest request)
Updates the user profile information.

Inherited Method Summary

Public Constructors

public FirebaseUser ()

Public Methods

public Task<Void> delete ()

Deletes the user record from your Firebase project's database. If the operation is successful, the user will be signed out.

Important: this is a security sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and later call reauthenticate(AuthCredential).

Exceptions

public abstract String getDisplayName ()

Returns the main display name of this user from the Firebase project's user database. Unlike the display name property from instances of UserInfo corresponding to authentication providers (like Google Sign-In), which is not modifiable, this name can be updated at any time by calling updateProfile(UserProfileChangeRequest).

This field will be automatically populated on account creation if the AuthCredential used on signInWithCredential(AuthCredential) contained such information.

public abstract String getEmail ()

Returns the main email address of the user, as stored in the Firebase project's user database. Unlike the email property from instances of UserInfo corresponding to authentication providers (like Github), which is not modifiable, this email address can be updated at any time by calling updateEmail(String).

This field will be automatically populated on account creation if the AuthCredential used on signInWithCredential(AuthCredential) contained such information, or if the account was created with createUserWithEmailAndPassword(String, String).

If the user also has a password, this email address can be used to sign in into the account using signInWithEmailAndPassword(String, String).

This email address is displayed in the Users section of the Firebase console.

public Task<GetTokenResult> getIdToken (boolean forceRefresh)

Fetches a Firebase Auth ID Token for the user; useful when authenticating against your own backend. Use our server SDKs or follow the official documentation to securely verify the integrity and validity of this token.

Exceptions
  • FirebaseAuthInvalidUserException if forceRefresh == true, thrown if the current user's account has been disabled, deleted, or its credentials are no longer valid
Parameters
forceRefresh force refreshes the token. Should only be set to true if the token is invalidated out of band.
Returns

public abstract FirebaseUserMetadata getMetadata ()

Returns the FirebaseUserMetadata associated with this user.

public abstract String getPhoneNumber ()

Returns the phone number of the user, as stored in the Firebase project's user database, or null if none exists. This can be updated at any time by calling updatePhoneNumber(PhoneAuthCredential).

This field will be automatically populated on account creation if the AuthCredential used on signInWithCredential(AuthCredential) contained such information. This phone number is displayed in the Users section of the Firebase console.

public abstract Uri getPhotoUrl ()

Returns the URL of this user's main profile picture, as stored in the Firebase project's user database. Unlike the profile URL property from instances of UserInfo corresponding to authentication providers (like Facebook Login), which is not modifiable, this URL can be updated at any time by calling updateProfile(UserProfileChangeRequest).

This field will be automatically populated on account creation if the AuthCredential used on signInWithCredential(AuthCredential) contained such information.

public abstract List<? extends UserInfo> getProviderData ()

Returns a List of UserInfo objects that represents the linked identities of the user using different authentication providers that may be linked to their account. Use this to access, for example, your user's basic profile information retrieved from Facebook whether or not the user used Facebook Login to sign in to the current session.

public abstract String getProviderId ()

Always returns PROVIDER_ID

public abstract String getUid ()

Returns a string used to uniquely identify your user in your Firebase project's user database. Use it when storing information in Firebase Database or Storage, or even in your own backend.

This identifier is opaque and does not correspond necessarily to the user's email address or any other field.

public abstract boolean isAnonymous ()

Returns true if the user is anonymous; that is, the user account was created with signInAnonymously() and has not been linked to another account with linkWithCredential(AuthCredential).

public Task<AuthResult> linkWithCredential (AuthCredential credential)

Attaches the given AuthCredential to the user. This allows the user to sign in to this account in the future with credentials for such provider.

Exceptions
Parameters
credential a valid credential of a type not yet linked to this user
Returns

public Task<Void> reauthenticate (AuthCredential credential)

Reauthenticates the user with the given credential. This is useful for operations that require a recent sign-in, to prevent or resolve a FirebaseAuthRecentLoginRequiredException.

Exceptions
Parameters
credential authentication credential that must be valid for the current user.

public Task<AuthResult> reauthenticateAndRetrieveData (AuthCredential credential)

Reauthenticates the user with the given credential, and returns the profile data for that account. This is useful for operations that require a recent sign-in, to prevent or resolve a FirebaseAuthRecentLoginRequiredException.

Exceptions
Parameters
credential authentication credential that must be valid for the current user.
Returns

public Task<Void> reload ()

Manually refreshes the data of the current user (for example, attached providers, display name, and so on).

Exceptions

public Task<Void> sendEmailVerification (ActionCodeSettings actionCodeSettings)

Initiates email verification for the user. Takes in an ActionCodeSettings to allow linking back to your app in the email.

Returns
  • Task to track completion of the sending operation.

public Task<Void> sendEmailVerification ()

Calls sendEmailVerification(ActionCodeSettings) with null actionCodeSettings.

public Task<AuthResult> unlink (String provider)

Detaches credentials from a given provider type from this user. This prevents the user from signing in to this account in the future with credentials from such provider.

Exceptions
Parameters
provider a unique identifier of the type of provider to be unlinked, for example, PROVIDER_ID.
Returns

public Task<Void> updateEmail (String email)

Updates the email address of the user.

Important: this is a security sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and later call reauthenticate(AuthCredential).

In addition, note that the original email address recipient will receive an email that allows them to revoke the email address change, in order to protect them from account hijacking.

Exceptions

public Task<Void> updatePassword (String password)

Updates the password of the user.

Important: this is a security sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and later call reauthenticate(AuthCredential).

Anonymous users who update both their email and password will no longer be anonymous. They will be able to log in with these credentials.

Exceptions

public Task<Void> updatePhoneNumber (PhoneAuthCredential credential)

Updates the phone number of the user.

Important: this is a security sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and later call reauthenticate(AuthCredential).

Exceptions

public Task<Void> updateProfile (UserProfileChangeRequest request)

Updates the user profile information. Use UserProfileChangeRequest.Builder to construct the request.

Exceptions