| java.lang.Object | |
| ↳ | com.google.firebase.auth.FirebaseAuth |
The entry point of the Firebase Authentication SDK.
First, obtain an instance of this class by calling getInstance().
Then, sign up or sign in a user with one of the following methods:
createUserWithEmailAndPassword(String, String)
signInWithEmailAndPassword(String, String)
signInWithCredential(AuthCredential)
signInAnonymously()
signInWithCustomToken(String)
getCurrentUser() to get a FirebaseUser object,
which contains information about the signed-in user.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| FirebaseAuth.AuthStateListener | Listener called when there is a change in the authentication state. | ||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Registers a listener to changes in the authentication state.
| |||||||||||
Tries to create a new user account with the given email address and password.
| |||||||||||
Returns a list of authentication providers that can be used to sign in a given user
(identified by its main email address).
| |||||||||||
Returns the currently signed-in
FirebaseUser or null if there is none. | |||||||||||
Returns an instance of this class corresponding to the default
FirebaseApp instance. | |||||||||||
Returns an instance of this class corresponding to the given
FirebaseApp instance. | |||||||||||
Unregisters a listener to authentication changes.
| |||||||||||
Triggers the Firebase Authentication backend to send a password-reset email to the given
email address, which must correspond to an existing user of your app.
| |||||||||||
Signs in the user anonymously without requiring any credential.
| |||||||||||
Tries to sign in a user with the given
AuthCredential. | |||||||||||
Tries to sign in a user with a given Custom Token.
| |||||||||||
Tries to sign in a user with the given email address and password.
| |||||||||||
Signs out the current user and clears it from the disk cache.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Registers a listener to changes in the authentication state. There can be more than one
listener registered at the same time for one or more FirebaseAuth instances.
The listeners call back in the UI thread, on the following events:
It is a recommended practice to always listen to sign-out events, as you may want to prompt the user to sign in again and maybe restrict the information or actions they have access to.
Use removeAuthStateListener(AuthStateListener) to unregister a listener.
Tries to create a new user account with the given email address and password. If successful, it also signs the user in into the app.
Access the signed-in user with getCurrentUser().
Upon successful completion, this operation triggers an
onAuthStateChanged(FirebaseAuth) event in all registered
FirebaseAuth.AuthStateListeners.
Important: you must enable Email & Password accounts in the Firebase console before you can use this method.
FirebaseAuthWeakPasswordException thrown if the password is not strong enough
FirebaseAuthInvalidCredentialsException thrown if the email address is
malformedFirebaseAuthUserCollisionException thrown if there already exists an account
with the given email addressTask of AuthResult with the result of the operation
Returns a list of authentication providers that can be used to sign in a given user (identified by its main email address).
This method is useful when you support multiple authentication mechanisms if you want to
implement an email-first authentication flow. It is also useful to resolve a
FirebaseAuthUserCollisionException thrown on
signInWithCredential(AuthCredential).
FirebaseAuthInvalidCredentialsException thrown if the email address is
malformed| the email address that identifies the user to fetch the providers from |
Task of ProviderQueryResult with the result of the operation
Returns the currently signed-in FirebaseUser or null if there is none.
Use getCurrentUser() != null to check if a user is signed in.
Returns an instance of this class corresponding to the default FirebaseApp instance.
Returns an instance of this class corresponding to the given FirebaseApp instance.
Unregisters a listener to authentication changes.
Triggers the Firebase Authentication backend to send a password-reset email to the given email address, which must correspond to an existing user of your app.
FirebaseAuthInvalidUserException thrown if there is no user corresponding to
the given email addressTask to track completion of the sending operation
Signs in the user anonymously without requiring any credential.
This method creates a new account in your Firebase Authentication system, except in the case
where there was already an anonymous user signed in into this app. Access the signed-in user
with getCurrentUser().
Upon successful completion, this operation triggers an
onAuthStateChanged(FirebaseAuth) event in all registered
FirebaseAuth.AuthStateListeners.
Anonymous users do not require any credential, and are useful in situations where you want to persist information about your users before asking them to sign in. For example, they may be useful when implementing a signed-out shopping cart in an e-commerce application.
Due to the unauthenticated nature of this kind of user, they are not transferrable across
devices. In order to allow your app's users to keep their information, ask them to provide
some other authentication credentials, and link them to the current user with
linkWithCredential(AuthCredential).
Important: you must enable Anonymous accounts in the Firebase console before being able to use them.
Task of AuthResult with the result of the operation
Tries to sign in a user with the given AuthCredential.
Use this method to sign in a user into your Firebase Authentication system. First retrieve
the credential either directly from the user, in case of EmailAuthCredential,
or from a supported authentication SDK, such as Google Sign-In or Facebook. Later access the
signed-in user with getCurrentUser().
For all AuthCredential types except EmailAuthCredential, this method will
create an account for the user in the case that it didn't exist before.
Important: you must configure the authentication providers in the Firebase console before you can use them.
FirebaseAuthInvalidUserException thrown if the user account you are trying to
sign in to has been disabled. Also thrown if credential is an
EmailAuthCredential with an email address that does not correspond to an
existing user.FirebaseAuthInvalidCredentialsException thrown if the credential is
malformed or has expired. If credential instanceof EmailAuthCredential it will
be thrown if the password is incorrect.FirebaseAuthUserCollisionException thrown if there already exists an account
with the email address asserted by the credential. Resolve this case by calling
fetchProvidersForEmail(String) and then asking the user to sign in using one
of them.Task of AuthResult with the result of the operation
Tries to sign in a user with a given Custom Token.
Use this method after you retrieve a Firebase Auth Custom Token from your server, to sign in
a user into your Firebase Authentication system. Access the signed-in user with
getCurrentUser().
Upon successful completion, this operation triggers an
onAuthStateChanged(FirebaseAuth) event in all registered
FirebaseAuth.AuthStateListeners.
This operation might create an account if the uid specified in the token corresponds
to a user without a record in the system.
Read how to use Custom Token authentication and the cases where it is useful in the guides.
FirebaseAuthInvalidCredentialsException thrown if the token format is
incorrect or if it corresponds to a different Firebase AppTask of AuthResult with the result of the operation
Tries to sign in a user with the given email address and password.
Access the signed-in user with getCurrentUser().
Upon successful completion, this operation triggers an
onAuthStateChanged(FirebaseAuth) event in all registered
FirebaseAuth.AuthStateListeners.
This is equivalent to calling signInWithCredential(AuthCredential) with an
EmailAuthCredential.
Important: you must enable Email & Password accounts in the Firebase console before being able to use this method.
FirebaseAuthInvalidUserException thrown if the user account corresponding to
email does not exist or has been disabledFirebaseAuthInvalidCredentialsException thrown if the password is
wrongTask of AuthResult with the result of the operation
Signs out the current user and clears it from the disk cache.
Upon successful completion, this operation triggers an
onAuthStateChanged(FirebaseAuth) event in all registered
FirebaseAuth.AuthStateListeners.