displayName

Inherited fromUser.displayName

email

Inherited fromUser.email

emailVerified

isAnonymous

metadata

multiFactor

phoneNumber

OverridesUserInfo.phoneNumber

photoURL

Inherited fromUser.photoURL

providerData

providerId

Inherited fromUser.providerId

refreshToken

tenantId

uid

Inherited fromUser.uid

delete

• delete():Promise<void>

• Deletes and signs out the user.

  Important: this is a security-sensitive operation that requires theuser to have recently signed in. If this requirement isn't met, ask the userto authenticate again and then callfirebase.User.reauthenticateWithCredential.

  Error Codes

  auth/requires-recent-login

  Thrown if the user's last sign-in time does not meet the securitythreshold. Usefirebase.User.reauthenticateWithCredential toresolve. This does not apply if the user is anonymous.

  ReturnsPromise<void>

getIdToken

• getIdToken(forceRefresh?: boolean):Promise<string>

• Returns a JSON Web Token (JWT) used to identify the user to a Firebaseservice.

  Returns the current token if it has not expired. Otherwise, this willrefresh the token and return a new one.

  Parameters

  • Optional forceRefresh:boolean

    Force refresh regardless of tokenexpiration.

  ReturnsPromise<string>

getIdTokenResult

• getIdTokenResult(forceRefresh?: boolean):Promise<IdTokenResult>

• Parameters

  • Optional forceRefresh:boolean

  ReturnsPromise<IdTokenResult>

linkAndRetrieveDataWithCredential

• linkAndRetrieveDataWithCredential(credential: AuthCredential):Promise<UserCredential>

• deprecated

  This method is deprecated. Usefirebase.User.linkWithCredential instead.

  Links the user account with the given credentials and returns any availableadditional user information, such as user name.

  Error Codes

  auth/provider-already-linked

  Thrown if the provider has already been linked to the user. This error isthrown even if this is not the same provider's account that is currentlylinked to the user.

  auth/invalid-credential

  Thrown if the provider's credential is not valid. This can happen if ithas already expired when calling link, or if it used invalid token(s).See the Firebase documentation for your provider, and make sure you passin the correct parameters to the credential method.

  auth/credential-already-in-use

  Thrown if the account corresponding to the credential already existsamong your users, or is already linked to a Firebase User.For example, this error could be thrown if you are upgrading an anonymoususer to a Google user by linking a Google credential to it and the Googlecredential used is already associated with an existing Firebase Googleuser.The fieldserror.email,error.phoneNumber, anderror.credential (firebase.auth.AuthCredential)may be provided, depending on the type of credential. You can recoverfrom this error by signing in witherror.credential directlyviafirebase.auth.Auth.signInWithCredential.

  auth/email-already-in-use

  Thrown if the email corresponding to the credential already existsamong your users. When thrown while linking a credential to an existinguser, anerror.email anderror.credential(firebase.auth.AuthCredential) fields are also provided.You have to link the credential to the existing user with that email ifyou wish to continue signing in with that credential. To do so, callfirebase.auth.Auth.fetchSignInMethodsForEmail, sign in toerror.email via one of the providers returned and thenfirebase.User.linkWithCredential the original credential to thatnewly signed in user.

  auth/operation-not-allowed

  Thrown if you have not enabled the provider in the Firebase Console. Goto the Firebase Console for your project, in the Auth section and theSign in Method tab and configure the provider.

  auth/invalid-email

  Thrown if the email used in afirebase.auth.EmailAuthProvider.credential is invalid.

  auth/wrong-password

  Thrown if the password used in afirebase.auth.EmailAuthProvider.credential is not correct orwhen the user associated with the email does not have a password.

  auth/invalid-verification-code

  Thrown if the credential is afirebase.auth.PhoneAuthProvider.credential and the verificationcode of the credential is not valid.

  auth/invalid-verification-id

  Thrown if the credential is afirebase.auth.PhoneAuthProvider.credential and the verificationID of the credential is not valid.

  Parameters

  • credential:AuthCredential

    The auth credential.

  ReturnsPromise<UserCredential>

linkWithCredential

• linkWithCredential(credential: AuthCredential):Promise<UserCredential>

• Links the user account with the given credentials.

  Error Codes

  auth/provider-already-linked

  Thrown if the provider has already been linked to the user. This error isthrown even if this is not the same provider's account that is currentlylinked to the user.

  auth/invalid-credential

  Thrown if the provider's credential is not valid. This can happen if ithas already expired when calling link, or if it used invalid token(s).See the Firebase documentation for your provider, and make sure you passin the correct parameters to the credential method.

  auth/credential-already-in-use

  Thrown if the account corresponding to the credential already existsamong your users, or is already linked to a Firebase User.For example, this error could be thrown if you are upgrading an anonymoususer to a Google user by linking a Google credential to it and the Googlecredential used is already associated with an existing Firebase Googleuser.The fieldserror.email,error.phoneNumber, anderror.credential (firebase.auth.AuthCredential)may be provided, depending on the type of credential. You can recoverfrom this error by signing in witherror.credential directlyviafirebase.auth.Auth.signInWithCredential.

  auth/email-already-in-use

  Thrown if the email corresponding to the credential already existsamong your users. When thrown while linking a credential to an existinguser, anerror.email anderror.credential(firebase.auth.AuthCredential) fields are also provided.You have to link the credential to the existing user with that email ifyou wish to continue signing in with that credential. To do so, callfirebase.auth.Auth.fetchSignInMethodsForEmail, sign in toerror.email via one of the providers returned and thenfirebase.User.linkWithCredential the original credential to thatnewly signed in user.

  auth/operation-not-allowed

  Thrown if you have not enabled the provider in the Firebase Console. Goto the Firebase Console for your project, in the Auth section and theSign in Method tab and configure the provider.

  auth/invalid-email

  Thrown if the email used in afirebase.auth.EmailAuthProvider.credential is invalid.

  auth/wrong-password

  Thrown if the password used in afirebase.auth.EmailAuthProvider.credential is not correct orwhen the user associated with the email does not have a password.

  auth/invalid-verification-code

  Thrown if the credential is afirebase.auth.PhoneAuthProvider.credential and the verificationcode of the credential is not valid.

  auth/invalid-verification-id

  Thrown if the credential is afirebase.auth.PhoneAuthProvider.credential and the verificationID of the credential is not valid.

  Parameters

  • credential:AuthCredential

    The auth credential.

  ReturnsPromise<UserCredential>

linkWithPhoneNumber

• linkWithPhoneNumber(phoneNumber: string, applicationVerifier: ApplicationVerifier):Promise<ConfirmationResult>

• Links the user account with the given phone number.

  Error Codes

  auth/provider-already-linked

  Thrown if the provider has already been linked to the user. This error isthrown even if this is not the same provider's account that is currentlylinked to the user.

  auth/captcha-check-failed

  Thrown if the reCAPTCHA response token was invalid, expired, or ifthis method was called from a non-whitelisted domain.

  auth/invalid-phone-number

  Thrown if the phone number has an invalid format.

  auth/missing-phone-number

  Thrown if the phone number is missing.

  auth/quota-exceeded

  Thrown if the SMS quota for the Firebase project has been exceeded.

  auth/user-disabled

  Thrown if the user corresponding to the given phone number has beendisabled.

  auth/credential-already-in-use

  Thrown if the account corresponding to the phone number already existsamong your users, or is already linked to a Firebase User.The fieldserror.phoneNumber anderror.credential (firebase.auth.AuthCredential)are provided in this case. You can recover from this error by signing inwith that credential directly viafirebase.auth.Auth.signInWithCredential.

  auth/operation-not-allowed

  Thrown if you have not enabled the phone authentication provider in theFirebase Console. Go to the Firebase Console for your project, in theAuth section and theSign in Method tab and configurethe provider.

  Parameters

  • phoneNumber:string

    The user's phone number in E.164 format (e.g.+16505550101).

  • applicationVerifier:ApplicationVerifier

  ReturnsPromise<ConfirmationResult>

linkWithPopup

• linkWithPopup(provider: AuthProvider):Promise<UserCredential>

• Links the authenticated provider to the user account using a pop-up basedOAuth flow.

  If the linking is successful, the returned result will contain the userand the provider's credential.

  Error Codes

  auth/auth-domain-config-required

  Thrown if authDomain configuration is not provided when callingfirebase.initializeApp(). Check Firebase Console for instructions ondetermining and passing that field.

  auth/cancelled-popup-request

  Thrown if successive popup operations are triggered. Only one popuprequest is allowed at one time on a user or an auth instance. All thepopups would fail with this error except for the last one.

  auth/credential-already-in-use

  Thrown if the account corresponding to the credential already existsamong your users, or is already linked to a Firebase User.For example, this error could be thrown if you are upgrading an anonymoususer to a Google user by linking a Google credential to it and the Googlecredential used is already associated with an existing Firebase Googleuser.Anerror.email anderror.credential(firebase.auth.AuthCredential) fields are also provided. You canrecover from this error by signing in with that credential directly viafirebase.auth.Auth.signInWithCredential.

  auth/email-already-in-use

  Thrown if the email corresponding to the credential already existsamong your users. When thrown while linking a credential to an existinguser, anerror.email anderror.credential(firebase.auth.AuthCredential) fields are also provided.You have to link the credential to the existing user with that email ifyou wish to continue signing in with that credential. To do so, callfirebase.auth.Auth.fetchSignInMethodsForEmail, sign in toerror.email via one of the providers returned and thenfirebase.User.linkWithCredential the original credential to thatnewly signed in user.

  auth/operation-not-allowed

  Thrown if you have not enabled the provider in the Firebase Console. Goto the Firebase Console for your project, in the Auth section and theSign in Method tab and configure the provider.

  auth/popup-blocked

  auth/operation-not-supported-in-this-environment

  Thrown if this operation is not supported in the environment yourapplication is running on. "location.protocol" must be http or https.

  Thrown if the popup was blocked by the browser, typically when thisoperation is triggered outside of a click handler.

  auth/popup-closed-by-user

  Thrown if the popup window is closed by the user without completing thesign in to the provider.

  auth/provider-already-linked

  Thrown if the provider has already been linked to the user. This error isthrown even if this is not the same provider's account that is currentlylinked to the user.

  auth/unauthorized-domain

  Thrown if the app domain is not authorized for OAuth operations for yourFirebase project. Edit the list of authorized domains from the Firebaseconsole.

  This method does not work in a Node.js environment.

  example

  // Creates the provider object.var provider =new firebase.auth.FacebookAuthProvider();// You can add additional scopes to the provider:provider.addScope('email');provider.addScope('user_friends');// Link with popup:user.linkWithPopup(provider).then(function(result){// The firebase.User instance:var user = result.user;// The Facebook firebase.auth.AuthCredential containing the Facebook// access token:var credential = result.credential;},function(error){// An error happened.});

  Parameters

  • provider:AuthProvider

    The provider to authenticate.The provider has to be an OAuth provider. Non-OAuth providers likefirebase.auth.EmailAuthProvider will throw an error.

  ReturnsPromise<UserCredential>

linkWithRedirect

• linkWithRedirect(provider: AuthProvider):Promise<void>

• Links the authenticated provider to the user account using a full-pageredirect flow.

  Error Codes

  auth/auth-domain-config-required

  Thrown if authDomain configuration is not provided when callingfirebase.initializeApp(). Check Firebase Console for instructions ondetermining and passing that field.

  auth/operation-not-supported-in-this-environment

  Thrown if this operation is not supported in the environment yourapplication is running on. "location.protocol" must be http or https.

  auth/provider-already-linked

  Thrown if the provider has already been linked to the user. This error isthrown even if this is not the same provider's account that is currentlylinked to the user.

  auth/unauthorized-domain

  Thrown if the app domain is not authorized for OAuth operations for yourFirebase project. Edit the list of authorized domains from the Firebaseconsole.

  Parameters

  • provider:AuthProvider

    The provider to authenticate.The provider has to be an OAuth provider. Non-OAuth providers likefirebase.auth.EmailAuthProvider will throw an error.

  ReturnsPromise<void>

reauthenticateAndRetrieveDataWithCredential

• reauthenticateAndRetrieveDataWithCredential(credential: AuthCredential):Promise<UserCredential>

• deprecated

  This method is deprecated. Usefirebase.User.reauthenticateWithCredential instead.

  Re-authenticates a user using a fresh credential, and returns any availableadditional user information, such as user name. Use before operationssuch asfirebase.User.updatePassword that require tokens from recentsign-in attempts.

  Error Codes

  auth/user-mismatch

  Thrown if the credential given does not correspond to the user.

  auth/user-not-found

  Thrown if the credential given does not correspond to any existing user.

  auth/invalid-credential

  Thrown if the provider's credential is not valid. This can happen if ithas already expired when calling link, or if it used invalid token(s).See the Firebase documentation for your provider, and make sure you passin the correct parameters to the credential method.

  auth/invalid-email

  Thrown if the email used in afirebase.auth.EmailAuthProvider.credential is invalid.

  auth/wrong-password

  Thrown if the password used in afirebase.auth.EmailAuthProvider.credential is not correct or whenthe user associated with the email does not have a password.

  auth/invalid-verification-code

  Thrown if the credential is afirebase.auth.PhoneAuthProvider.credential and the verificationcode of the credential is not valid.

  auth/invalid-verification-id

  Thrown if the credential is afirebase.auth.PhoneAuthProvider.credential and the verificationID of the credential is not valid.

  Parameters

  • credential:AuthCredential

  ReturnsPromise<UserCredential>

reauthenticateWithCredential

• reauthenticateWithCredential(credential: AuthCredential):Promise<UserCredential>

• Re-authenticates a user using a fresh credential. Use before operationssuch asfirebase.User.updatePassword that require tokens from recentsign-in attempts.

  Error Codes

  auth/user-mismatch

  Thrown if the credential given does not correspond to the user.

  auth/user-not-found

  Thrown if the credential given does not correspond to any existing user.

  auth/invalid-credential

  Thrown if the provider's credential is not valid. This can happen if ithas already expired when calling link, or if it used invalid token(s).See the Firebase documentation for your provider, and make sure you passin the correct parameters to the credential method.

  auth/invalid-email

  Thrown if the email used in afirebase.auth.EmailAuthProvider.credential is invalid.

  auth/wrong-password

  Thrown if the password used in afirebase.auth.EmailAuthProvider.credential is not correct or whenthe user associated with the email does not have a password.

  auth/invalid-verification-code

  Thrown if the credential is afirebase.auth.PhoneAuthProvider.credential and the verificationcode of the credential is not valid.

  auth/invalid-verification-id

  Thrown if the credential is afirebase.auth.PhoneAuthProvider.credential and the verificationID of the credential is not valid.

  Parameters

  • credential:AuthCredential

  ReturnsPromise<UserCredential>

reauthenticateWithPhoneNumber

• reauthenticateWithPhoneNumber(phoneNumber: string, applicationVerifier: ApplicationVerifier):Promise<ConfirmationResult>

• Re-authenticates a user using a fresh credential. Use before operationssuch asfirebase.User.updatePassword that require tokens from recentsign-in attempts.

  Error Codes

  auth/user-mismatch

  Thrown if the credential given does not correspond to the user.

  auth/user-not-found

  Thrown if the credential given does not correspond to any existing user.

  auth/captcha-check-failed

  Thrown if the reCAPTCHA response token was invalid, expired, or ifthis method was called from a non-whitelisted domain.

  auth/invalid-phone-number

  Thrown if the phone number has an invalid format.

  auth/missing-phone-number

  Thrown if the phone number is missing.

  auth/quota-exceeded

  Thrown if the SMS quota for the Firebase project has been exceeded.

  Parameters

  • phoneNumber:string

    The user's phone number in E.164 format (e.g.+16505550101).

  • applicationVerifier:ApplicationVerifier

  ReturnsPromise<ConfirmationResult>

reauthenticateWithPopup

• reauthenticateWithPopup(provider: AuthProvider):Promise<UserCredential>

• Reauthenticates the current user with the specified provider using a pop-upbased OAuth flow.

  If the reauthentication is successful, the returned result will contain theuser and the provider's credential.

  Error Codes

  auth/auth-domain-config-required

  Thrown if authDomain configuration is not provided when callingfirebase.initializeApp(). Check Firebase Console for instructions ondetermining and passing that field.

  auth/cancelled-popup-request

  Thrown if successive popup operations are triggered. Only one popuprequest is allowed at one time on a user or an auth instance. All thepopups would fail with this error except for the last one.

  auth/user-mismatch

  Thrown if the credential given does not correspond to the user.

  auth/operation-not-allowed

  Thrown if you have not enabled the provider in the Firebase Console. Goto the Firebase Console for your project, in the Auth section and theSign in Method tab and configure the provider.

  auth/popup-blocked

  Thrown if the popup was blocked by the browser, typically when thisoperation is triggered outside of a click handler.

  auth/operation-not-supported-in-this-environment

  Thrown if this operation is not supported in the environment yourapplication is running on. "location.protocol" must be http or https.

  auth/popup-closed-by-user

  Thrown if the popup window is closed by the user without completing thesign in to the provider.

  auth/unauthorized-domain

  Thrown if the app domain is not authorized for OAuth operations for yourFirebase project. Edit the list of authorized domains from the Firebaseconsole.

  This method does not work in a Node.js environment.

  example

  // Creates the provider object.var provider =new firebase.auth.FacebookAuthProvider();// You can add additional scopes to the provider:provider.addScope('email');provider.addScope('user_friends');// Reauthenticate with popup:user.reauthenticateWithPopup(provider).then(function(result){// The firebase.User instance:var user = result.user;// The Facebook firebase.auth.AuthCredential containing the Facebook// access token:var credential = result.credential;},function(error){// An error happened.});

  Parameters

  • provider:AuthProvider

    The provider to authenticate.The provider has to be an OAuth provider. Non-OAuth providers likefirebase.auth.EmailAuthProvider will throw an error.

  ReturnsPromise<UserCredential>

reauthenticateWithRedirect

• reauthenticateWithRedirect(provider: AuthProvider):Promise<void>

• Reauthenticates the current user with the specified OAuth provider using afull-page redirect flow.

  Error Codes

  auth/auth-domain-config-required

  Thrown if authDomain configuration is not provided when callingfirebase.initializeApp(). Check Firebase Console for instructions ondetermining and passing that field.

  auth/operation-not-supported-in-this-environment

  Thrown if this operation is not supported in the environment yourapplication is running on. "location.protocol" must be http or https.

  auth/user-mismatch

  Thrown if the credential given does not correspond to the user.

  auth/unauthorized-domain

  Thrown if the app domain is not authorized for OAuth operations for yourFirebase project. Edit the list of authorized domains from the Firebaseconsole.

  This method does not work in a Node.js environment.

  Parameters

  • provider:AuthProvider

    The provider to authenticate.The provider has to be an OAuth provider. Non-OAuth providers likefirebase.auth.EmailAuthProvider will throw an error.

  ReturnsPromise<void>

reload

• reload():Promise<void>

• Refreshes the current user, if signed in.

  ReturnsPromise<void>

sendEmailVerification

• sendEmailVerification(actionCodeSettings?: ActionCodeSettings |null):Promise<void>

• Sends a verification email to a user.

  The verification process is completed by callingfirebase.auth.Auth.applyActionCode

  Error Codes

  auth/missing-android-pkg-name

  An Android package name must be provided if the Android app is requiredto be installed.

  auth/missing-continue-uri

  A continue URL must be provided in the request.

  auth/missing-ios-bundle-id

  An iOS bundle ID must be provided if an App Store ID is provided.

  auth/invalid-continue-uri

  The continue URL provided in the request is invalid.

  auth/unauthorized-continue-uri

  The domain of the continue URL is not whitelisted. Whitelistthe domain in the Firebase console.

  example

  var actionCodeSettings = {url:'https://www.example.com/cart?email=user@example.com&cartId=123',iOS: {bundleId:'com.example.ios'  },android: {packageName:'com.example.android',installApp:true,minimumVersion:'12'  },handleCodeInApp:true};firebase.auth().currentUser.sendEmailVerification(actionCodeSettings)    .then(function(){// Verification email sent.    })    .catch(function(error){// Error occurred. Inspect error.code.    });

  Parameters

  • Optional actionCodeSettings:ActionCodeSettings |null

    The actioncode settings. If specified, the state/continue URL will be set as the"continueUrl" parameter in the email verification link. The default emailverification landing page will use this to display a link to go back tothe app if it is installed.If the actionCodeSettings is not specified, no URL is appended to theaction URL.The state URL provided must belong to a domain that is whitelisted by thedeveloper in the console. Otherwise an error will be thrown.Mobile app redirects will only be applicable if the developer configuresand accepts the Firebase Dynamic Links terms of condition.The Android package name and iOS bundle ID will be respected only if theyare configured in the same Firebase Auth project used.

  ReturnsPromise<void>

toJSON

• toJSON():Object

• Returns a JSON-serializable representation of this object.

  ReturnsObject

  A JSON-serializable representation of this object.

unlink

• unlink(providerId: string):Promise<User>

• Unlinks a provider from a user account.

  Error Codes

  auth/no-such-provider

  Thrown if the user does not have this provider linked or when theprovider ID given does not exist.

  Parameters

  • providerId:string

  ReturnsPromise<User>

updateEmail

• updateEmail(newEmail: string):Promise<void>

• Updates the user's email address.

  An email will be sent to the original email address (if it was set) thatallows to revoke the email address change, in order to protect them fromaccount hijacking.

  Important: this is a security sensitive operation that requires theuser to have recently signed in. If this requirement isn't met, ask the userto authenticate again and then callfirebase.User.reauthenticateWithCredential.

  Error Codes

  auth/invalid-email

  Thrown if the email used is invalid.

  auth/email-already-in-use

  Thrown if the email is already used by another user.

  auth/requires-recent-login

  Thrown if the user's last sign-in time does not meet the securitythreshold. Usefirebase.User.reauthenticateWithCredential toresolve. This does not apply if the user is anonymous.

  Parameters

  • newEmail:string

    The new email address.

  ReturnsPromise<void>

updatePassword

• updatePassword(newPassword: string):Promise<void>

• Updates the user's password.

  Important: this is a security sensitive operation that requires theuser to have recently signed in. If this requirement isn't met, ask the userto authenticate again and then callfirebase.User.reauthenticateWithCredential.

  Error Codes

  auth/weak-password

  Thrown if the password is not strong enough.

  auth/requires-recent-login

  Thrown if the user's last sign-in time does not meet the securitythreshold. Usefirebase.User.reauthenticateWithCredential toresolve. This does not apply if the user is anonymous.

  Parameters

  • newPassword:string

  ReturnsPromise<void>

updatePhoneNumber

• updatePhoneNumber(phoneCredential: AuthCredential):Promise<void>

• Updates the user's phone number.

  Error Codes

  auth/invalid-verification-code

  Thrown if the verification code of the credential is not valid.

  auth/invalid-verification-id

  Thrown if the verification ID of the credential is not valid.

  Parameters

  • phoneCredential:AuthCredential

  ReturnsPromise<void>

updateProfile

• updateProfile(profile: {displayName?:string |null;photoURL?:string |null }):Promise<void>

• Updates a user's profile data.

  example

  // Updates the user attributes:user.updateProfile({displayName:"Jane Q. User",photoURL:"https://example.com/jane-q-user/profile.jpg"}).then(function(){// Profile updated successfully!// "Jane Q. User"var displayName = user.displayName;// "https://example.com/jane-q-user/profile.jpg"var photoURL = user.photoURL;},function(error){// An error happened.});// Passing a null value will delete the current attribute's value, but not// passing a property won't change the current attribute's value:// Let's say we're using the same user than before, after the update.user.updateProfile({photoURL:null}).then(function(){// Profile updated successfully!// "Jane Q. User", hasn't changed.var displayName = user.displayName;// Now, this is null.var photoURL = user.photoURL;},function(error){// An error happened.});

  Parameters

  • profile:{displayName?:string |null;photoURL?:string |null }

    The profile'sdisplayName and photoURL to update.

    • Optional displayName?:string |null

    • Optional photoURL?:string |null

  ReturnsPromise<void>

verifyBeforeUpdateEmail

• verifyBeforeUpdateEmail(newEmail: string, actionCodeSettings?: ActionCodeSettings |null):Promise<void>

• Sends a verification email to a new email address. The user's email will beupdated to the new one after being verified.

  If you have a custom email action handler, you can complete the verificationprocess by callingfirebase.auth.Auth.applyActionCode.

  Error Codes

  auth/missing-android-pkg-name

  An Android package name must be provided if the Android app is requiredto be installed.

  auth/missing-continue-uri

  A continue URL must be provided in the request.

  auth/missing-ios-bundle-id

  An iOS bundle ID must be provided if an App Store ID is provided.

  auth/invalid-continue-uri

  The continue URL provided in the request is invalid.

  auth/unauthorized-continue-uri

  The domain of the continue URL is not whitelisted. Whitelistthe domain in the Firebase console.

  example

  var actionCodeSettings = {url:'https://www.example.com/cart?email=user@example.com&cartId=123',iOS: {bundleId:'com.example.ios'  },android: {packageName:'com.example.android',installApp:true,minimumVersion:'12'  },handleCodeInApp:true};firebase.auth().currentUser.verifyBeforeUpdateEmail('user@example.com', actionCodeSettings)  .then(function(){// Verification email sent.  })  .catch(function(error){// Error occurred. Inspect error.code.  });

  Parameters

  • newEmail:string

    The email address to be verified and updated to.

  • Optional actionCodeSettings:ActionCodeSettings |null

    The actioncode settings. If specified, the state/continue URL will be set as the"continueUrl" parameter in the email verification link. The default emailverification landing page will use this to display a link to go back tothe app if it is installed.If the actionCodeSettings is not specified, no URL is appended to theaction URL.The state URL provided must belong to a domain that is whitelisted by thedeveloper in the console. Otherwise an error will be thrown.Mobile app redirects will only be applicable if the developer configuresand accepts the Firebase Dynamic Links terms of condition.The Android package name and iOS bundle ID will be respected only if theyare configured in the same Firebase Auth project used.

  ReturnsPromise<void>