firebase

property code

code: string;

• Error codes are strings using the following format: "service/string-code". Some examples include "app/no-app" and "auth/user-not-found".

  While the message for a given error can change, the code will remain the same between backward-compatible versions of the Firebase SDK.

property message

message: string;

• An explanatory message for the error that just occurred.

  This message is designed to be helpful to you, the developer. Because it generally does not convey meaningful information to end users, this message should not be displayed in your application.

property name

name: 'FirebaseError';

• The name of the class of errors, which is "FirebaseError".

property stack

stack?: string;

• A string value containing the execution backtrace when the error originally occurred. This may not always be available.

  When it is available, this information can be sent to to help explain the cause of an error.

property aud

aud: string;

• Always set to PROJECT_ID

property auth_time

auth_time: number;

• The time the user authenticated, normally 'iat'

property email

email?: string;

• The user's primary email

property email_verified

email_verified?: boolean;

• The user's email verification status

property exp

exp: number;

• The token expiry time, normally 'iat' + 3600

property firebase

firebase: {
    /** The primary sign-in provider */
    sign_in_provider: FirebaseSignInProvider;

    /** A map of providers to the user's list of unique identifiers from each provider */
    identities?: { [provider in FirebaseSignInProvider]?: string[] };
};

• Information on all identities linked to this user

property iat

iat: number;

• The token issue time, in seconds since epoch

property iss

iss: string;

• Always set to https://securetoken.google.com/PROJECT_ID

property name

name?: string;

• The user's display name

property phone_number

phone_number?: string;

• The user's primary phone number

property picture

picture?: string;

• The user's profile photo URL

property provider_id

provider_id?: 'anonymous';

• The sign in provider, only set when the provider is 'anonymous'

property sub

sub: string;

• The user's unique ID

property uid

uid?: never;

property user_id

user_id: string;

• The user's unique ID. Must be equal to 'sub'

index signature

[claim: string]: unknown;

• Custom claims set by the developer

property complete

complete: CompleteFn;

property error

error: ErrorFn<E>;

property next

next: NextFn<T>;

property emailVerified

emailVerified: boolean;

property isAnonymous

isAnonymous: boolean;

property metadata

metadata: firebase.auth.UserMetadata;

property multiFactor

multiFactor: firebase.User.MultiFactorUser;

• The firebase.User.MultiFactorUser object corresponding to the current user. This is used to access all multi-factor properties and operations related to the current user.

property phoneNumber

phoneNumber: string | null;

• The phone number normalized based on the E.164 standard (e.g. +16505550101) for the current user. This is null if the user has no phone credential linked to the account.

property providerData

providerData: (firebase.UserInfo | null)[];

property refreshToken

refreshToken: string;

property tenantId

tenantId: string | null;

• The current user's tenant ID. This is a read-only property, which indicates the tenant ID used to sign in the current user. This is null if the user is signed in from the parent project.

  Example 1

  // Set the tenant ID on Auth instance.
  firebase.auth().tenantId = ‘TENANT_PROJECT_ID’;
  
  // All future sign-in request now include tenant ID.
  firebase.auth().signInWithEmailAndPassword(email, password)
    .then(function(result) {
      // result.user.tenantId should be ‘TENANT_PROJECT_ID’.
    }).catch(function(error) {
      // Handle error.
    });

method delete

delete: () => Promise<void>;

• Deletes and signs out 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 then call firebase.User.reauthenticateWithCredential.

  Error Codes auth/requires-recent-login Thrown if the user's last sign-in time does not meet the security threshold. Use firebase.User.reauthenticateWithCredential to resolve. This does not apply if the user is anonymous.

method getIdToken

getIdToken: (forceRefresh?: boolean) => Promise<string>;

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

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

  Parameter forceRefresh

  Force refresh regardless of token expiration.

method getIdTokenResult

getIdTokenResult: (forceRefresh?: boolean) => Promise<auth.IdTokenResult>;

method linkAndRetrieveDataWithCredential

linkAndRetrieveDataWithCredential: (
    credential: auth.AuthCredential
) => Promise<auth.UserCredential>;

• Links the user account with the given credentials and returns any available additional 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 is thrown even if this is not the same provider's account that is currently linked to the user. auth/invalid-credential Thrown if the provider's credential is not valid. This can happen if it has already expired when calling link, or if it used invalid token(s). See the Firebase documentation for your provider, and make sure you pass in the correct parameters to the credential method. auth/credential-already-in-use Thrown if the account corresponding to the credential already exists among your users, or is already linked to a Firebase User. For example, this error could be thrown if you are upgrading an anonymous user to a Google user by linking a Google credential to it and the Google credential used is already associated with an existing Firebase Google user. The fields error.email, error.phoneNumber, and error.credential (firebase.auth.AuthCredential) may be provided, depending on the type of credential. You can recover from this error by signing in with error.credential directly via firebase.auth.Auth.signInWithCredential. auth/email-already-in-use Thrown if the email corresponding to the credential already exists among your users. When thrown while linking a credential to an existing user, an error.email and error.credential (firebase.auth.AuthCredential) fields are also provided. You have to link the credential to the existing user with that email if you wish to continue signing in with that credential. To do so, call firebase.auth.Auth.fetchSignInMethodsForEmail, sign in to error.email via one of the providers returned and then firebase.User.linkWithCredential the original credential to that newly signed in user. auth/operation-not-allowed Thrown if you have not enabled the provider in the Firebase Console. Go to the Firebase Console for your project, in the Auth section and the Sign in Method tab and configure the provider. auth/invalid-email Thrown if the email used in a firebase.auth.EmailAuthProvider.credential is invalid. auth/wrong-password Thrown if the password used in a firebase.auth.EmailAuthProvider.credential is not correct or when the user associated with the email does not have a password. auth/invalid-verification-code Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification code of the credential is not valid. auth/invalid-verification-id Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid.

  Parameter credential

  The auth credential.

  Deprecated

  This method is deprecated. Use firebase.User.linkWithCredential instead.

method linkWithCredential

linkWithCredential: (
    credential: auth.AuthCredential
) => Promise<auth.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 is thrown even if this is not the same provider's account that is currently linked to the user. auth/invalid-credential Thrown if the provider's credential is not valid. This can happen if it has already expired when calling link, or if it used invalid token(s). See the Firebase documentation for your provider, and make sure you pass in the correct parameters to the credential method. auth/credential-already-in-use Thrown if the account corresponding to the credential already exists among your users, or is already linked to a Firebase User. For example, this error could be thrown if you are upgrading an anonymous user to a Google user by linking a Google credential to it and the Google credential used is already associated with an existing Firebase Google user. The fields error.email, error.phoneNumber, and error.credential (firebase.auth.AuthCredential) may be provided, depending on the type of credential. You can recover from this error by signing in with error.credential directly via firebase.auth.Auth.signInWithCredential. auth/email-already-in-use Thrown if the email corresponding to the credential already exists among your users. When thrown while linking a credential to an existing user, an error.email and error.credential (firebase.auth.AuthCredential) fields are also provided. You have to link the credential to the existing user with that email if you wish to continue signing in with that credential. To do so, call firebase.auth.Auth.fetchSignInMethodsForEmail, sign in to error.email via one of the providers returned and then firebase.User.linkWithCredential the original credential to that newly signed in user. auth/operation-not-allowed Thrown if you have not enabled the provider in the Firebase Console. Go to the Firebase Console for your project, in the Auth section and the Sign in Method tab and configure the provider. auth/invalid-email Thrown if the email used in a firebase.auth.EmailAuthProvider.credential is invalid. auth/wrong-password Thrown if the password used in a firebase.auth.EmailAuthProvider.credential is not correct or when the user associated with the email does not have a password. auth/invalid-verification-code Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification code of the credential is not valid. auth/invalid-verification-id Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid.

  Parameter credential

  The auth credential.

method linkWithPhoneNumber

linkWithPhoneNumber: (
    phoneNumber: string,
    applicationVerifier: auth.ApplicationVerifier
) => Promise<auth.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 is thrown even if this is not the same provider's account that is currently linked to the user. auth/captcha-check-failed Thrown if the reCAPTCHA response token was invalid, expired, or if this 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 been disabled. auth/credential-already-in-use Thrown if the account corresponding to the phone number already exists among your users, or is already linked to a Firebase User. The fields error.phoneNumber and error.credential (firebase.auth.AuthCredential) are provided in this case. You can recover from this error by signing in with that credential directly via firebase.auth.Auth.signInWithCredential. auth/operation-not-allowed Thrown if you have not enabled the phone authentication provider in the Firebase Console. Go to the Firebase Console for your project, in the Auth section and the Sign in Method tab and configure the provider.

  Parameter phoneNumber

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

  Parameter applicationVerifier

method linkWithPopup

linkWithPopup: (provider: auth.AuthProvider) => Promise<auth.UserCredential>;

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

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

  Error Codes auth/auth-domain-config-required Thrown if authDomain configuration is not provided when calling firebase.initializeApp(). Check Firebase Console for instructions on determining and passing that field. auth/cancelled-popup-request Thrown if successive popup operations are triggered. Only one popup request is allowed at one time on a user or an auth instance. All the popups would fail with this error except for the last one. auth/credential-already-in-use Thrown if the account corresponding to the credential already exists among your users, or is already linked to a Firebase User. For example, this error could be thrown if you are upgrading an anonymous user to a Google user by linking a Google credential to it and the Google credential used is already associated with an existing Firebase Google user. An error.email and error.credential (firebase.auth.AuthCredential) fields are also provided. You can recover from this error by signing in with that credential directly via firebase.auth.Auth.signInWithCredential. auth/email-already-in-use Thrown if the email corresponding to the credential already exists among your users. When thrown while linking a credential to an existing user, an error.email and error.credential (firebase.auth.AuthCredential) fields are also provided. You have to link the credential to the existing user with that email if you wish to continue signing in with that credential. To do so, call firebase.auth.Auth.fetchSignInMethodsForEmail, sign in to error.email via one of the providers returned and then firebase.User.linkWithCredential the original credential to that newly signed in user. auth/operation-not-allowed Thrown if you have not enabled the provider in the Firebase Console. Go to the Firebase Console for your project, in the Auth section and the Sign 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 your application is running on. "location.protocol" must be http or https. Thrown if the popup was blocked by the browser, typically when this operation is triggered outside of a click handler. auth/popup-closed-by-user Thrown if the popup window is closed by the user without completing the sign in to the provider. auth/provider-already-linked Thrown if the provider has already been linked to the user. This error is thrown even if this is not the same provider's account that is currently linked to the user. auth/unauthorized-domain Thrown if the app domain is not authorized for OAuth operations for your Firebase project. Edit the list of authorized domains from the Firebase console.

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

  Parameter provider

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

  Example 1

  // 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.
  });

method linkWithRedirect

linkWithRedirect: (provider: auth.AuthProvider) => Promise<void>;

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

  Error Codes auth/auth-domain-config-required Thrown if authDomain configuration is not provided when calling firebase.initializeApp(). Check Firebase Console for instructions on determining and passing that field. auth/operation-not-supported-in-this-environment Thrown if this operation is not supported in the environment your application 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 is thrown even if this is not the same provider's account that is currently linked to the user. auth/unauthorized-domain Thrown if the app domain is not authorized for OAuth operations for your Firebase project. Edit the list of authorized domains from the Firebase console.

  Parameter provider

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

method reauthenticateAndRetrieveDataWithCredential

reauthenticateAndRetrieveDataWithCredential: (
    credential: auth.AuthCredential
) => Promise<auth.UserCredential>;

• Re-authenticates a user using a fresh credential, and returns any available additional user information, such as user name. Use before operations such as firebase.User.updatePassword that require tokens from recent sign-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 it has already expired when calling link, or if it used invalid token(s). See the Firebase documentation for your provider, and make sure you pass in the correct parameters to the credential method. auth/invalid-email Thrown if the email used in a firebase.auth.EmailAuthProvider.credential is invalid. auth/wrong-password Thrown if the password used in a firebase.auth.EmailAuthProvider.credential is not correct or when the user associated with the email does not have a password. auth/invalid-verification-code Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification code of the credential is not valid. auth/invalid-verification-id Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid.

  Parameter credential

  Deprecated

  This method is deprecated. Use firebase.User.reauthenticateWithCredential instead.

method reauthenticateWithCredential

reauthenticateWithCredential: (
    credential: auth.AuthCredential
) => Promise<auth.UserCredential>;

• Re-authenticates a user using a fresh credential. Use before operations such as firebase.User.updatePassword that require tokens from recent sign-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 it has already expired when calling link, or if it used invalid token(s). See the Firebase documentation for your provider, and make sure you pass in the correct parameters to the credential method. auth/invalid-email Thrown if the email used in a firebase.auth.EmailAuthProvider.credential is invalid. auth/wrong-password Thrown if the password used in a firebase.auth.EmailAuthProvider.credential is not correct or when the user associated with the email does not have a password. auth/invalid-verification-code Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification code of the credential is not valid. auth/invalid-verification-id Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid.

  Parameter credential

method reauthenticateWithPhoneNumber

reauthenticateWithPhoneNumber: (
    phoneNumber: string,
    applicationVerifier: auth.ApplicationVerifier
) => Promise<auth.ConfirmationResult>;

• Re-authenticates a user using a fresh credential. Use before operations such as firebase.User.updatePassword that require tokens from recent sign-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 if this 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.

  Parameter phoneNumber

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

  Parameter applicationVerifier

method reauthenticateWithPopup

reauthenticateWithPopup: (
    provider: auth.AuthProvider
) => Promise<auth.UserCredential>;

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

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

  Error Codes auth/auth-domain-config-required Thrown if authDomain configuration is not provided when calling firebase.initializeApp(). Check Firebase Console for instructions on determining and passing that field. auth/cancelled-popup-request Thrown if successive popup operations are triggered. Only one popup request is allowed at one time on a user or an auth instance. All the popups 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. Go to the Firebase Console for your project, in the Auth section and the Sign in Method tab and configure the provider. auth/popup-blocked Thrown if the popup was blocked by the browser, typically when this operation is triggered outside of a click handler. auth/operation-not-supported-in-this-environment Thrown if this operation is not supported in the environment your application 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 the sign in to the provider. auth/unauthorized-domain Thrown if the app domain is not authorized for OAuth operations for your Firebase project. Edit the list of authorized domains from the Firebase console.

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

  Parameter provider

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

  Example 1

  // 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.
  });

method reauthenticateWithRedirect

reauthenticateWithRedirect: (provider: auth.AuthProvider) => Promise<void>;

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

  Error Codes auth/auth-domain-config-required Thrown if authDomain configuration is not provided when calling firebase.initializeApp(). Check Firebase Console for instructions on determining and passing that field. auth/operation-not-supported-in-this-environment Thrown if this operation is not supported in the environment your application 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 your Firebase project. Edit the list of authorized domains from the Firebase console.

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

  Parameter provider

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

method reload

reload: () => Promise<void>;

• Refreshes the current user, if signed in.

method sendEmailVerification

sendEmailVerification: (
    actionCodeSettings?: auth.ActionCodeSettings
) => Promise<void>;

• Sends a verification email to a user.

  The verification process is completed by calling firebase.auth.Auth.applyActionCode

  Error Codes auth/missing-android-pkg-name An Android package name must be provided if the Android app is required to 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. Whitelist the domain in the Firebase console.

  Parameter actionCodeSettings

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

  Example 1

  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.
      });

method toJSON

toJSON: () => Object;

• Returns a JSON-serializable representation of this object.

  A JSON-serializable representation of this object.

method unlink

unlink: (providerId: string) => Promise<firebase.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 the provider ID given does not exist.

  Parameter providerId

method 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) that allows to revoke the email address change, in order to protect them from account hijacking.

  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 then call firebase.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 security threshold. Use firebase.User.reauthenticateWithCredential to resolve. This does not apply if the user is anonymous.

  Parameter newEmail

  The new email address.

method updatePassword

updatePassword: (newPassword: string) => Promise<void>;

• Updates the user's password.

  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 then call firebase.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 security threshold. Use firebase.User.reauthenticateWithCredential to resolve. This does not apply if the user is anonymous.

  Parameter newPassword

method updatePhoneNumber

updatePhoneNumber: (phoneCredential: auth.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.

  Parameter phoneCredential

method updateProfile

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

• Updates a user's profile data.

  Parameter profile

  The profile's displayName and photoURL to update.

  Example 1

  // 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.
  });

method verifyBeforeUpdateEmail

verifyBeforeUpdateEmail: (
    newEmail: string,
    actionCodeSettings?: auth.ActionCodeSettings
) => Promise<void>;

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

  If you have a custom email action handler, you can complete the verification process by calling firebase.auth.Auth.applyActionCode.

  Error Codes auth/missing-android-pkg-name An Android package name must be provided if the Android app is required to 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. Whitelist the domain in the Firebase console.

  Parameter newEmail

  The email address to be verified and updated to.

  Parameter actionCodeSettings

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

  Example 1

  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.
    });

property displayName

displayName: string | null;

property email

email: string | null;

property phoneNumber

phoneNumber: string | null;

property photoURL

photoURL: string | null;

property providerId

providerId: string;

property uid

uid: string;

• The user's unique ID.

property app

app: firebase.app.App;

• The associated with the Analytics service instance.

  Example 1

  var app = analytics.app;

method logEvent

logEvent: {
    (
        eventName: 'add_payment_info',
        eventParams?: {
            [key: string]: any;
            coupon?: EventParams['coupon'];
            currency?: EventParams['currency'];
            items?: EventParams['items'];
            payment_type?: EventParams['payment_type'];
            value?: EventParams['value'];
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'add_shipping_info',
        eventParams?: {
            [key: string]: any;
            coupon?: string;
            currency?: string;
            items?: Item[];
            shipping_tier?: string;
            value?: number;
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart',
        eventParams?: {
            [key: string]: any;
            currency?: string;
            value?: number;
            items?: Item[];
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'begin_checkout',
        eventParams?: {
            [key: string]: any;
            currency?: string;
            coupon?: string;
            value?: number;
            items?: Item[];
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'checkout_progress',
        eventParams?: {
            [key: string]: any;
            currency?: string;
            coupon?: string;
            value?: number;
            items?: Item[];
            checkout_step?: number;
            checkout_option?: string;
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'exception',
        eventParams?: {
            [key: string]: any;
            description?: string;
            fatal?: boolean;
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'generate_lead',
        eventParams?: { [key: string]: any; value?: number; currency?: string },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'login',
        eventParams?: { [key: string]: any; method?: string },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'page_view',
        eventParams?: {
            [key: string]: any;
            page_title?: string;
            page_location?: string;
            page_path?: string;
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'purchase' | 'refund',
        eventParams?: {
            [key: string]: any;
            value?: number;
            currency?: string;
            transaction_id: string;
            tax?: Currency;
            shipping?: Currency;
            items?: Item[];
            coupon?: string;
            affiliation?: string;
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'screen_view',
        eventParams?: {
            [key: string]: any;
            firebase_screen: string;
            firebase_screen_class: string;
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'search' | 'view_search_results',
        eventParams?: { [key: string]: any; search_term?: string },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'select_content',
        eventParams?: {
            [key: string]: any;
            content_type?: string;
            item_id?: string;
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'select_item',
        eventParams?: {
            [key: string]: any;
            items?: Item[];
            item_list_name?: string;
            item_list_id?: string;
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'select_promotion' | 'view_promotion',
        eventParams?: {
            [key: string]: any;
            items?: Item[];
            promotion_id?: string;
            promotion_name?: string;
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'set_checkout_option',
        eventParams?: {
            [key: string]: any;
            checkout_step?: number;
            checkout_option?: string;
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'share',
        eventParams?: {
            [key: string]: any;
            method?: string;
            content_type?: string;
            item_id?: string;
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'sign_up',
        eventParams?: { [key: string]: any; method?: string },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'timing_complete',
        eventParams?: {
            [key: string]: any;
            name: string;
            value: number;
            event_category?: string;
            event_label?: string;
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'view_cart' | 'view_item',
        eventParams?: {
            [key: string]: any;
            currency?: string;
            items?: Item[];
            value?: number;
        },
        options?: AnalyticsCallOptions
    ): void;
    (
        eventName: 'view_item_list',
        eventParams?: {
            [key: string]: any;
            items?: Item[];
            item_list_name?: string;
            item_list_id?: string;
        },
        options?: AnalyticsCallOptions
    ): void;
    <T extends string>(
        eventName: CustomEventName<T>,
        eventParams?: { [key: string]: any },
        options?: AnalyticsCallOptions
    ): void;
};

• Sends analytics event with given eventParams. This method automatically associates this logged event with this Firebase web app instance on this device. List of recommended event parameters can be found in the GA4 reference documentation.

• Sends analytics event with given eventParams. This method automatically associates this logged event with this Firebase web app instance on this device. See Measure exceptions.

• Sends analytics event with given eventParams. This method automatically associates this logged event with this Firebase web app instance on this device. See Page views.

• Sends analytics event with given eventParams. This method automatically associates this logged event with this Firebase web app instance on this device. See Track Screenviews.

method setAnalyticsCollectionEnabled

setAnalyticsCollectionEnabled: (enabled: boolean) => void;

• Sets whether analytics collection is enabled for this app on this device. window['ga-disable-analyticsId'] = true;

method setCurrentScreen

setCurrentScreen: (screenName: string, options?: AnalyticsCallOptions) => void;

• Use gtag 'config' command to set 'screen_name'.

  Deprecated

  Use logEvent with eventName as 'screen_view' and add relevant eventParams. See Track Screenviews.

method setUserId

setUserId: (id: string, options?: AnalyticsCallOptions) => void;

• Use gtag 'config' command to set 'user_id'.

method setUserProperties

setUserProperties: (
    properties: CustomParams,
    options?: AnalyticsCallOptions
) => void;

• Use gtag 'config' command to set all params specified.

property global

global: boolean;

• If true, this config or event call applies globally to all analytics properties on the page.

property event_callback

event_callback?: () => void;

property event_timeout

event_timeout?: number;

property groups

groups?: string | string[];

property send_to

send_to?: string | string[];

index signature

[key: string]: any;

property affiliation

affiliation?: string;

property checkout_option

checkout_option?: string;

property checkout_step

checkout_step?: number;

property content_type

content_type?: string;

property coupon

coupon?: string;

property currency

currency?: string;

property description

description?: string;

property event_category

event_category: string;

property event_label

event_label?: string;

property fatal

fatal?: boolean;

property firebase_screen

firebase_screen?: string;

• Firebase-specific. Use to log a screen_name to Firebase Analytics.

property firebase_screen_class

firebase_screen_class?: string;

• Firebase-specific. Use to log a screen_class to Firebase Analytics.

property item_id

item_id?: string;

property item_list_id

item_list_id?: string;

property item_list_name

item_list_name?: string;

property items

items?: Item[];

property method

method?: string;

property number

number?: string;

property payment_type

payment_type?: string;

property promotion_id

promotion_id?: string;

property promotion_name

promotion_name?: string;

property promotions

promotions?: Promotion[];

property screen_name

screen_name?: string;

property search_term

search_term?: string;

property shipping

shipping?: Currency;

property shipping_tier

shipping_tier?: string;

property tax

tax?: Currency;

property transaction_id

transaction_id?: string;

property value

value?: number;

property affiliation

affiliation?: string;

property brand

brand?: string;

• Deprecated

  Use item_brand instead.

property category

category?: string;

• Deprecated

  Use item_category instead.

property coupon

coupon?: string;

property creative_name

creative_name?: string;

property creative_slot

creative_slot?: string;

property discount

discount?: Currency;

property id

id?: string;

• Deprecated

  Use item_id instead.

property index

index?: number;

property item_brand

item_brand?: string;

property item_category

item_category?: string;

property item_category2

item_category2?: string;

property item_category3

item_category3?: string;

property item_category4

item_category4?: string;

property item_category5

item_category5?: string;

property item_id

item_id?: string;

property item_list_id

item_list_id?: string;