UserPlatform class abstract

A user account.

Inheritance
  • Object
  • PlatformInterface
  • UserPlatform

Properties

auth FirebaseAuthPlatform
The FirebaseAuthPlatform instance.
final
displayName String?
The users display name.
no setter
email String?
The users email address.
no setter
hashCode int
The hash code for this object.
no setterinherited
isAnonymous bool
Returns whether the user is a anonymous.
no setter
isEmailVerified bool
Returns whether the users email address has been verified.
no setter
metadata UserMetadata
Returns additional metadata about the user, such as their creation time.
no setter
multiFactor MultiFactorPlatform
final
phoneNumber String?
Returns the users phone number.
no setter
photoURL String?
Returns a photo URL for the user.
no setter
providerData List<UserInfo>
Returns a list of user information for each linked provider.
no setter
refreshToken String?
Returns a JWT refresh token for the user.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
tenantId String?
The current user's tenant ID.
no setter
uid String
The user's unique ID.
no setter

Methods

delete() Future<void>
Deletes and signs out the user.
getIdToken(bool forceRefresh) Future<String?>
Returns a JSON Web Token (JWT) used to identify the user to a Firebase service.
getIdTokenResult(bool forceRefresh) Future<IdTokenResult>
Returns a IdTokenResult containing the users JSON Web Token (JWT) and other metadata.
linkWithCredential(AuthCredential credential) Future<UserCredentialPlatform>
Links the user account with the given credentials.
linkWithPhoneNumber(String phoneNumber, RecaptchaVerifierFactoryPlatform applicationVerifier) Future<ConfirmationResultPlatform>
Links the user account with the given phone number.
linkWithPopup(AuthProvider provider) Future<UserCredentialPlatform>
Links the user account with the given provider.
linkWithProvider(AuthProvider provider) Future<UserCredentialPlatform>
Signs in with an AuthProvider using native authentication flow. On Web you should use linkWithPopup or linkWithRedirect instead.
linkWithRedirect(AuthProvider provider) Future<void>
Links the user account with the given provider.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reauthenticateWithCredential(AuthCredential credential) Future<UserCredentialPlatform>
Re-authenticates a user using a fresh credential.
reauthenticateWithPopup(AuthProvider provider) Future<UserCredentialPlatform>
Renews the user’s authentication using the provided auth provider instance. On mobile you should use reauthenticateWithProvider instead.
reauthenticateWithProvider(AuthProvider provider) Future<UserCredentialPlatform>
Renews the user’s authentication using the provided auth provider instance. On Web you should use linkWithPopup instead.
reauthenticateWithRedirect(AuthProvider provider) Future<void>
Renews the user’s authentication using the provided auth provider instance. On mobile you should use reauthenticateWithProvider instead.
reload() Future<void>
Refreshes the current user, if signed in.
sendEmailVerification(ActionCodeSettings? actionCodeSettings) Future<void>
Sends a verification email to a user.
toString() String
A string representation of this object.
inherited
Unlinks a provider from a user account.
updateEmail(String newEmail) Future<void>
Updates the user's email address.
updatePassword(String newPassword) Future<void>
Updates the user's password.
updatePhoneNumber(PhoneAuthCredential phoneCredential) Future<void>
Updates the user's phone number.
updateProfile(Map<String, String?> profile) Future<void>
Updates a user's profile data.
verifyBeforeUpdateEmail(String newEmail, [ActionCodeSettings? actionCodeSettings]) Future<void>
Sends a verification email to a new email address. The user's email will be updated to the new one after being verified.

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

verify(UserPlatform instance) → void
Ensures that any delegate class has extended a UserPlatform.
override