core library

Classes

AccessToken: Class that contains the facebook access token data
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.
AppleAuthCredential: The auth credential returned from calling AppleAuthProvider.credential.
AppleAuthProvider: This class should be used to either create a new Apple credential with an access code, or use the provider to trigger user authentication flows.
AppleIDAuthorizationRequest: An AuthorizationRequest which authenticates a user based on their Apple ID.
AppleLogoPainter: A custom painter which draws Apple's logo inside its boundaries.
Auth<Key extends AuthKeys>: Create an authorized model class for User:
AuthBuilder<T extends Auth<AuthKeys>>
AuthConsumer<T extends Auth<AuthKeys>>
AuthController<T extends Auth<AuthKeys>>
AuthControllerImpl<T extends Auth<AuthKeys>>
AuthConverter: Provides methods for modifying and converting values.
AuthCredential: Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements.
AuthDataSource
AuthDataSourceImpl
AuthenticationOptions: Options wrapper for LocalAuthPlatform.authenticate parameters.
Authenticator
AuthHandler
AuthHandlerImpl
AuthHelper
AuthKeys: Create an authorized key class for User:
AuthMessage
AuthMessages
AuthObserver<T extends Auth<AuthKeys>>
AuthorizationCredentialAppleID: Authorization details from a successful Sign in with Apple flow.
AuthorizationCredentialPassword: Authorization details retrieved from the user's Keychain for the current app's website.
AuthorizationRequest: A base class which describes an authorization request that we will make on the native side.
AuthorizedDataSource<T extends Auth<AuthKeys>>
AuthorizedDataSourceImpl<T extends Auth<AuthKeys>>
AuthPatterns
AuthProvider<T extends Auth<AuthKeys>>
AuthRepository
AuthRepositoryImpl
AuthResponse<T extends Auth<AuthKeys>>
AuthValidator
BackupHandler<T extends Auth<AuthKeys>>
BackupHandlerImpl<T extends Auth<AuthKeys>>
BackupRepository<T extends Auth<AuthKeys>>
BackupRepositoryImpl<T extends Auth<AuthKeys>>
BiometricConfig
ConfirmationResult: A result from a phone number sign-in, link, or reauthenticate call.
Connectivity: Discover network connectivity configurations: Distinguish between WI-FI and cellular, check WI-FI status and more.
ConnectivityPlusLinuxPlugin: The Linux implementation of ConnectivityPlatform.
Credential
EmailAuthCredential: The auth credential returned from calling EmailAuthProvider.credential.
EmailAuthenticator
EmailAuthProvider: A EmailAuthCredential can be created by calling EmailAuthProvider.credential with an email and password.
Entity<Key extends EntityKey>: Represents an entity with a unique identifier and timestamp.
EntityKey: Represents the keys associated with an entity.
FacebookAuth: this class implements the FacebookAuthPlatform interface and calls to the native APIs on Android, iOS and web.
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.
FacebookPermissions: this class is used to saved the granted and declined permissions after login
FirebaseAuth: The entry point of the Firebase Authentication SDK.
GameCenterAuthCredential: The auth credential returned from calling GameCenterAuthProvider.credential.
GameCenterAuthProvider: This class should be used to create a new Game Center credential to trigger an authentication flow on Apple platform.
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.
GoogleIdentity: Encapsulation of the fields that represent a Google user's identity.
GoogleSignIn: GoogleSignIn allows you to authenticate Google users.
GoogleSignInAccount: Holds fields describing a signed in user's identity, following GoogleSignInUserData.
GoogleSignInAuthentication: Holds authentication tokens after sign in.
GoogleUserCircleAvatar: Builds a CircleAvatar profile image of the appropriate resolution
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.
KeepDataSource<T extends Auth<AuthKeys>>
LocalAuthentication: A Flutter plugin for authenticating the user identity locally.
LoginResult: class to handle a login request
MicrosoftAuthCredential: The auth credential returned from calling MicrosoftAuthProvider.credential.
MicrosoftAuthProvider: This class should be used to either create a new Microsoft credential with an access code, or use the provider to trigger user authentication flows.
MultiFactor: Defines multi-factor related properties and operations pertaining to a User. This class acts as the main entry point for enrolling or un-enrolling second factors for a user, and provides access to their currently enrolled factors.
MultiFactorAssertion: Represents an assertion that the Firebase Authentication server can use to authenticate a user as part of a multi-factor flow.
MultiFactorInfo: Represents a single second factor means for the user.
MultiFactorResolver: Utility class that contains methods to resolve second factor requirements on users that have opted into two-factor authentication.
MultiFactorSession: Identifies the current session to enroll a second factor or to complete sign in when previously enrolled.
OAuthAuthenticator
OAuthCredential: A generic OAuth credential.
OAuthProvider: A generic provider instance.
OtpAuthenticator
PasswordAuthorizationRequest: An AuthorizationRequest that uses credentials which are stored in the users Keychain.
PhoneAuthCredential: The auth credential returned from calling PhoneAuthProvider.credential.
PhoneAuthenticator
PhoneAuthProvider: This class should be used to either create a new Phone credential with an verification ID and SMS code.
PhoneMultiFactorGenerator: Provider for generating a PhoneMultiFactorAssertion.
PhoneMultiFactorInfo: Represents the information for a phone second factor.
PlayGamesAuthCredential: The auth credential returned from calling PlayGamesAuthProvider.credential.
PlayGamesAuthProvider: This class should be used to either create a new Play Games credential with an access code, or use the provider to trigger user authentication flows.
RecaptchaVerifier: An reCAPTCHA-based application verifier.
Response<T extends Object>: Represents the response of an operation, containing various flags, data, and status. T represents the type of data being handled.
ResponseMessages
SAMLAuthProvider: Security Assertion Markup Language based provider.
SharedPreferences: Wraps NSUserDefaults (on iOS) and SharedPreferences (on Android), providing a persistent store for simple data.
SignInWithApple: Wrapper class providing the methods to interact with Sign in with Apple.
SignInWithAppleBuilder: A widget for conditionally rendering UI based on whether or not Sign in with Apple is available
SignInWithAppleButton: A Sign in with Apple button according to the Apple Guidelines.
TotpMultiFactorGenerator: Provider for generating a PhoneMultiFactorAssertion.
TotpMultiFactorInfo: Represents the information for a phone second factor.
TotpSecret
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.
UsernameAuthenticator
WebAuthenticationOptions: Parameters required for web-based authentication flows
YahooAuthCredential: The auth credential returned from calling YahooAuthProvider.credential.
YahooAuthProvider: This class should be used to either create a new Yahoo credential with an access code, or use the provider to trigger user authentication flows.

Enums

ActionCodeInfoOperation: The type of operation that generated the action code from calling checkActionCode.
AppleIDAuthorizationScopes: The scopes that will be requested with the AppleIDAuthorizationRequest. This allows you to request additional information from the user upon sign up.
AuthorizationErrorCode: A description of why the authorization failed on the native side.
AuthProviders
AuthRegs
AuthState
AuthType
BiometricStatus
BiometricType: Various types of biometric authentication. Some platforms report specific biometric types, while others report only classifications like strong and weak.
ConnectivityResult: Connection status check result.
CredentialState: State of a credential of a particular user.
IconAlignment: This controls the alignment of the Apple Logo on the SignInWithAppleButton
LoginBehavior: defines the login ui Behavior on Android
LoginStatus
OtpType
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.
SignInOption: Default configuration options to use when signing in.
SignInWithAppleButtonStyle: The style of the button according to Apple's documentation.
Status

Extensions

AuthContextExtension on BuildContext
AuthFutureExtension on Future<AuthResponse<T>>
EntityMapHelper on Map<String, dynamic>
EntityObjectHelper on Object?: Extension methods to provide helper functionalities for object types that represent entities.
ResponseStatusExtension on Status?

Functions

generateNonce({int length = 32}) → String: Generate a cryptographically secure random nonce

Typedefs

EntityBuilder<T> = T Function(dynamic value): Defines a function signature for building entities from dynamic data.
IdentityBuilder = String Function(String uid)
NetworkManagerClientFactory = NetworkManagerClient Function()
OnAuthBuilder<T extends Auth<AuthKeys>> = Widget Function(BuildContext context, T? data)
OnAuthErrorListener = void Function(BuildContext context, String error)
OnAuthLoadingListener = void Function(BuildContext context, bool loading)
OnAuthMessageListener = void Function(BuildContext context, String message)
OnAuthStateChangeListener<T extends Auth<AuthKeys>> = void Function(BuildContext context, AuthState state, T? data)
OnAuthUserBuilder<T extends Auth<AuthKeys>> = Widget Function(BuildContext context, T? value)
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.
SignByBiometricCallback = Future<BiometricStatus?>? Function(BiometricStatus? status)
SignOutCallback = Future Function(Auth<AuthKeys> authorizer)
UndoAccountCallback = Future<bool> Function(Auth<AuthKeys> authorizer)

Exceptions / Errors

FirebaseAuthException: Generic exception related to Firebase Authentication. Check the error code and message for more details.
FirebaseAuthMultiFactorException: MultiFactor 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.
SignInWithAppleAuthorizationException: A SignInWithAppleException indicating something went wrong while authenticating.
SignInWithAppleCredentialsException
SignInWithAppleException: A more specific PlatformException which describes any potential native errors that occur within the Sign in with Apple plugin.
SignInWithAppleNotSupportedException: An SignInWithAppleException which will be thrown in case Sign in with Apple is not supported.
UnknownSignInWithAppleException: An SignInWithAppleException which will be thrown if a PlatformException can't be mapped to a more specific SignInWithAppleException.

Classes

Enums

Extensions

Functions

Typedefs

Exceptions / Errors

auth_management package

core library