firebase_auth library
Classes
- ActionCodeInfo
-
A response from calling
checkActionCode
. - ActionCodeSettings
- Interface that defines the required continue/state URL with optional Android and iOS bundle identifiers.
- AdditionalUserInfo
- A structure containing additional user information from a federated identity provider.
- AuthCredential
- Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements.
- ConfirmationResult
- A result from a phone number sign-in, link, or reauthenticate call.
- EmailAuthCredential
- The auth credential returned from calling EmailAuthProvider.credential.
- EmailAuthProvider
- A EmailAuthCredential can be created by calling EmailAuthProvider.credential with an email and password.
- FacebookAuthCredential
- The auth credential returned from calling FacebookAuthProvider.credential.
- FacebookAuthProvider
- This class should be used to either create a new Facebook credential with an access code, or use the provider to trigger user authentication flows.
- FirebaseAuth
- The entry point of the Firebase Authentication SDK.
- GithubAuthCredential
- The auth credential returned from calling GithubAuthProvider.credential.
- GithubAuthProvider
- This class should be used to either create a new GitHub credential with an access code, or use the provider to trigger user authentication flows.
- GoogleAuthCredential
- The auth credential returned from calling GoogleAuthProvider.credential.
- GoogleAuthProvider
- This class should be used to either create a new Google credential with an access code, or use the provider to trigger user authentication flows.
- IdTokenResult
-
Interface representing ID token result obtained from
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. - OAuthCredential
- A generic OAuth credential.
- OAuthProvider
- A generic provider instance.
- PhoneAuthCredential
- The auth credential returned from calling PhoneAuthProvider.credential.
- PhoneAuthProvider
- This class should be used to either create a new Phone credential with an verification ID and SMS code.
- RecaptchaVerifier
- An reCAPTCHA-based application verifier.
- SAMLAuthProvider
- Security Assertion Markup Language based provider.
- TwitterAuthCredential
- The auth credential returned from calling TwitterAuthProvider.credential.
- TwitterAuthProvider
- This class should be used to either create a new Twitter credential with an access code, or use the provider to trigger user authentication flows.
- User
- A user account.
- UserCredential
-
A UserCredential is returned from authentication requests such as
createUserWithEmailAndPassword
. - UserInfo
- User profile information, visible only to the Firebase project's apps.
- UserMetadata
- Interface representing a user's metadata.
Enums
- ActionCodeInfoOperation
-
The type of operation that generated the action code from calling
checkActionCode
. - Persistence
- An enumeration of the possible persistence mechanism types.
- RecaptchaVerifierSize
- A enum to represent a reCAPTCHA widget size.
- RecaptchaVerifierTheme
- A enum to represent a reCAPTCHA widget theme.
Typedefs
- PhoneCodeAutoRetrievalTimeout = void Function(String verificationId)
- Typedef for handling automatic phone number timeout resolution.
- PhoneCodeSent = void Function(String verificationId, int? forceResendingToken)
- Typedef for handling when Firebase sends a SMS code to the provided phone number.
- PhoneVerificationCompleted = void Function(PhoneAuthCredential phoneAuthCredential)
- Typedef for a automatic phone number resolution.
- PhoneVerificationFailed = void Function(FirebaseAuthException error)
- Typedef for handling errors via phone number verification.
- RecaptchaVerifierOnError = void Function(FirebaseAuthException exception)
- Called when the reCAPTCHA widget errors (such as a network error).
- RecaptchaVerifierOnExpired = void Function()
- Called when the time to complete the reCAPTCHA widget expires.
- RecaptchaVerifierOnSuccess = void Function()
- Called on successful completion of the reCAPTCHA widget.
Exceptions / Errors
- FirebaseAuthException
- Generic exception related to Firebase Authentication. Check the error code and message for more details.
- FirebaseException
- A generic class which provides exceptions in a Firebase-friendly format to users.