User class

User object wrapping the responses from identity toolkit.

Constructors

User(Map<String, dynamic> _user, FirebaseAuth _auth)
Return a dart user object from Google's identity toolkit response.

Properties

displayName → String?
The users display name.
no setter
email → String?
The users email address.
no setter
emailVerified → bool
Returns whether the users email address has been verified.
no setter
hashCode → int
The hash code for this object.
no setterinherited
isAnonymous → bool
Returns whether the user is a anonymous.
no setter
metadata → UserMetadata?
Returns additional metadata about the user, such as their creation time.
no setter
phoneNumber → String?
Returns the users phone number.
no setter
photoURL → String?
The photo URL of a user, could be null.
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 unique id of a user in Firebase.
no setter

Methods

delete() → Future<void>
Deletes and signs out the user.
getIdToken([bool forceRefresh = false]) → Future<String>
Returns a JSON Web Token (JWT) used to identify the user to a Firebase service.
getIdTokenResult([bool forceRefresh = false]) → Future<IdTokenResult>
Returns a IdTokenResult containing the users JSON Web Token (JWT) and other metadata.
linkWithCredential(AuthCredential credential) → Future<UserCredential>
Links the user account with the given credentials.
linkWithPhoneNumber(String phoneNumber, [RecaptchaVerifier? applicationVerifier]) → Future<ConfirmationResult>
Link the current user with the given phone number.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reauthenticateWithCredential(AuthCredential credential) → Future<UserCredential>
Re-authenticates a user using a fresh credential.
reload() → Future<void>
Refreshes the current user, if signed in.
sendEmailVerification() → Future<void>
Sends a verification email to a user.
toMap() → Map<String, dynamic>
A Map representation of this instance.
toString() → String
A string representation of this object.
inherited
Unlinks a provider from a user account.
updateDisplayName(String? displayName) → Future<void>
Update user's displayName.
updateEmail(String newEmail) → Future<void>
Updates the user's email address.
updatePassword(String newPassword) → Future<void>
Reset user password.
updatePhoneNumber(PhoneAuthCredential phoneCredential) → Future<void>
Updates the user's phone number.
updatePhotoURL(String? photoUrl) → Future<void>
Update user's photoUrl.
updateProfile({String? photoUrl = '', String? displayName = ''}) → Future<void>
Update user's profile.

Operators

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