Namespace FirebaseAuthTypes

Firebase Authentication package for React Native.

Example: Access the firebase export from the `auth` package:

import { firebase } from '@react-native-firebase/auth';

// firebase.auth().X

Example: Using the default export from the `auth` package:

import auth from '@react-native-firebase/auth';

// auth().X

Example: Using the default export from the `app` package:

import firebase from '@react-native-firebase/app';
import '@react-native-firebase/auth';

// firebase.auth().X

TODO

Salakar

Ehesp

missing auth providers (PhoneAuthProvider, Facebook etc)

Firebase

auth

Classes

Module: The Firebase Authentication service is available for the default app or a given app.
TotpSecret: Represents a TOTP secret that is used for enrolling a TOTP second factor. Contains the shared secret key and other parameters to generate time-based one-time passwords. Implements methods to retrieve the shared secret key, generate a QR code URL, and open the QR code URL in an OTP authenticator app.

Enumerations

FactorId: Identifies the type of a second factor.

Interfaces

ActionCodeInfo: The interface returned from a checkActionCode call.
ActionCodeInfoData: Additional data returned from a checkActionCode call. For the PASSWORD_RESET, VERIFY_EMAIL, and RECOVER_EMAIL actions, this object contains an email field with the address the email was sent to. For the RECOVER_EMAIL action, which allows a user to undo an email address change, this object also contains a fromEmail field with the user account's new email address. After the action completes, the user's email address will revert to the value in the email field from the value in fromEmail field.
ActionCodeSettings: Options to be sent with requests such as User#sendEmailVerification.
ActionCodeSettingsAndroid: Android specific options which can be attached to the ActionCodeSettings object to be sent with requests such as User#sendEmailVerification.
ActionCodeSettingsIos: iOS specific options which can be attached to the ActionCodeSettings object to be sent with requests such as User#sendEmailVerification.
AdditionalUserInfo: A structure containing additional user information from a federated identity provider via UserCredential.
AuthCredential: Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements.
AuthProvider: Interface that represents an auth provider. Implemented by other providers.
AuthSettings: Interface for module auth settings.
ConfirmationResult: A result from a signInWithPhoneNumber call.
EmailAuthProvider: Email and password auth provider implementation.
IdTokenResult: Interface representing ID token result obtained from User#getIdTokenResult. It contains the ID token JWT string and other helper properties for getting different data associated with the token as well as all the decoded payload claims.
MultiFactor: Holds information about the user's enrolled factors.
MultiFactorAssertion
MultiFactorError
MultiFactorInfoCommon
MultiFactorResolver: Facilitates the recovery when a user needs to provide a second factor to sign-in.
MultiFactorSession
MultiFactorUser: The entry point for most multi-factor operations.
NativeFirebaseAuthError
OAuthProvider: Interface that represents an OAuth provider. Implemented by other providers.
OIDCProvider: Interface that represents an Open ID Connect auth provider. Implemented by other providers.
PhoneAuthError: A custom error in the event verifying a phone number failed.
PhoneAuthListener: The listener function returned from a verifyPhoneNumber call.
PhoneAuthSnapshot: A snapshot interface of the current phone auth state.
PhoneAuthState
PhoneMultiFactorEnrollInfoOptions
PhoneMultiFactorGenerator
PhoneMultiFactorInfo
PhoneMultiFactorSignInInfoOptions
Statics: firebase.auth.X
TotpMultiFactorGenerator
TotpMultiFactorInfo
UpdateProfile: Request used to update user profile information.
User: 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.
UserCredential: A structure containing a User, an AuthCredential, the operationType, and any additional user information that was returned from the identity provider. operationType could be 'signIn' for a sign-in operation, 'link' for a linking operation and 'reauthenticate' for a re-authentication operation.
UserInfo: Represents a collection of standard profile information for a user. Can be used to expose profile information returned by an identity provider, such as Google Sign-In or Facebook Login.
UserMetadata: Holds the user metadata for the current User.

Type Aliases

AuthListenerCallback: An auth listener callback function for onAuthStateChanged.
getMultiFactorResolver: Try and obtain a #MultiFactorResolver instance based on an error. Returns null if no resolver object could be found.
multiFactor: Return the #MultiFactorUser instance for the current user.
MultiFactorInfo: Contains information about a second factor.

Namespace FirebaseAuthTypes

Example: Access the firebase export from the auth package:

Example: Using the default export from the auth package:

Example: Using the default export from the app package:

Salakar

Ehesp

Firebase

Classes

Enumerations

Interfaces

Type Aliases

Settings

On This Page

Example: Access the firebase export from the `auth` package:

Example: Using the default export from the `auth` package:

Example: Using the default export from the `app` package: