core library

Classes

AdditionalInfo
AndroidBiometricMessages
Android side authentication messages.
Auth<Key extends AuthKeys>
Create an authorized model class for User:
AuthBuilder<T extends Auth<AuthKeys>>
AuthChanges<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.
AuthDataSource
AuthDataSourceImpl
AuthDelegate
AuthDelegateException
Authenticator
AuthException
AuthHandler
AuthHandlerImpl
AuthHelper
AuthKeys
Create an authorized key class for User:
AuthMessage
AuthMessages
AuthObserver<T extends Auth<AuthKeys>>
AuthorizedDataSource<T extends Auth<AuthKeys>>
AuthorizedDataSourceImpl<T extends Auth<AuthKeys>>
AuthProvider<T extends Auth<AuthKeys>>
AuthRepository
AuthRepositoryImpl
AuthResponse<T extends Auth<AuthKeys>>
AuthRouter<T extends Auth<AuthKeys>>
BackupDelegate<T extends Auth<AuthKeys>>
BackupHandlerImpl<T extends Auth<AuthKeys>>
BackupRepository<T extends Auth<AuthKeys>>
BackupRepositoryImpl<T extends Auth<AuthKeys>>
BiometricButton<T extends Auth<AuthKeys>>
BiometricConfig
CaseInsensitiveEquality
String equality that's insensitive to differences in ASCII case.
Credential
DeepCollectionEquality
Deep equality on collections.
DefaultEquality<E>
Equality of objects that compares only the natural equality of the objects.
EmailAuthenticator
Entity<Key extends EntityKey>
Represents an entity with a unique identifier and timestamp.
EntityHelper
EntityKey
Represents the keys associated with an entity.
Equality<E>
A generic equality relation on objects.
EqualityBy<E, F>
Equality of objects based on derived values.
GuestAuthenticator
IAppleAuthDelegate
IAppleAuthorizationCredentialAppleID
IAppleAuthorizationCredentialPassword
IAppleWebAuthenticationOptions
Parameters required for web-based authentication flows
IBiometricAuthDelegate
A Flutter plugin for authenticating the user identity locally.
IBiometricMessages
Abstract class for storing platform specific strings.
IBiometricOptions
IdentityEquality<E>
Equality of objects that compares only the identity of the objects.
IFacebookAccessToken
IFacebookAuthDelegate
this class implements the FacebookAuthPlatform interface and calls to the native APIs on Android, iOS and web.
IFacebookClassicToken
IFacebookLimitedToken
IFacebookLoginResult
class to handle a login request
IGoogleAuthDelegate
IGoogleSignInAccount
Holds fields describing a signed in user's identity, following GoogleSignInUserData.
IGoogleSignInAuthentication
IGoogleSignInInitParameters
The parameters to use when initializing the sign in process.
IGoogleSignInTokenData
Holds authentication data after sign in.
IGoogleSignInUserData
Holds information about the signed in user.
Info
IOSBiometricMessages
Class wrapping all authentication messages needed on iOS. Provides default values for all messages.
IterableEquality<E>
Equality on iterables.
ListEquality<E>
Equality on lists.
MapEquality<K, V>
Equality on maps.
Metadata
Modifier<T extends Object>
MultiEquality<E>
Combines several equalities into a single equality.
OAuthAuthenticator
OauthButton<T extends Auth<AuthKeys>>
OAuthDelegates
OtpAuthenticator
PhoneAuthenticator
Response<T extends Object>
A generic response wrapper class that encapsulates API responses with status, data, and metadata information.
ResponseMessages
SetEquality<E>
Equality of sets.
UnorderedIterableEquality<E>
Equality of the elements of two iterables without considering order.
UserDelegate
UsernameAuthenticator
WindowsBiometricMessages
Windows side authentication messages.

Enums

AuthProviders
AuthStatus
AuthType
BiometricStatus
IAppleCredentialState
IAppleIDAuthorizationScopes
The scopes that will be requested with the AppleIDAuthorizationRequest. This allows you to request additional information from the user upon sign up.
IBiometricType
Various types of biometric authentication. Some platforms report specific biometric types, while others report only classifications like strong and weak.
IFacebookAccessTokenType
IFacebookLoginBehavior
defines the login ui Behavior on Android
IFacebookLoginStatus
IFacebookLoginTracking
IGoogleSignInOption
Default configuration options to use when signing in.
OauthButtonType
OtpType
Provider
Status

Extensions

AuthContextExtension on BuildContext
AuthLoadingExtension on Future<AuthResponse<T>>
EntityObjectHelper on Object?
Extension methods to provide helper functionalities for object types that represent entities.
ResponseStatusExtension on Status?
StringHelper on String?
StringsHelper on List<String>?

Functions

compareAsciiLowerCase(String a, String b) int
Compares a and b lexically, converting ASCII letters to lower case.
compareAsciiLowerCaseNatural(String a, String b) int
Compares strings a and b according to lower-case natural sort ordering.
compareAsciiUpperCase(String a, String b) int
Compares a and b lexically, converting ASCII letters to upper case.
compareAsciiUpperCaseNatural(String a, String b) int
Compares strings a and b according to upper-case natural sort ordering.
compareNatural(String a, String b) int
Compares strings a and b according to natural sort ordering.
equalsIgnoreAsciiCase(String a, String b) bool
Checks if strings a and b differ only on the case of ASCII letters.
hashIgnoreAsciiCase(String string) int
Hash code for a string which is compatible with equalsIgnoreAsciiCase.

Typedefs

Backup = Map<String, dynamic>
BackupReader = Future<String?> Function(String key)
BackupWriter = Future<bool> Function(String key, String? value)
BiometricButtonCallback = void Function(BuildContext context)
EntityBuilder<T> = T Function(dynamic value)
Defines a function signature for building entities from dynamic data.
IdentityBuilder = String Function(String uid)
OauthButtonCallback = void Function(BuildContext context)
OnAuthBuilder<T extends Auth<AuthKeys>> = Widget Function(BuildContext context, T? data)
OnAuthChanges<T extends Auth<AuthKeys>> = void Function(BuildContext context, AuthChanges<T> changes)
OnAuthError = void Function(BuildContext context, String error)
OnAuthLoading = void Function(BuildContext context, bool loading)
OnAuthMessage = void Function(BuildContext context, String message)
OnAuthMode = void Function(BuildContext context)
OnAuthStatus = void Function(BuildContext context, AuthStatus status)
OnAuthUserBuilder<T extends Auth<AuthKeys>> = Widget Function(BuildContext context, T? value)
SignByBiometricCallback = Future<BiometricStatus?>? Function(BiometricStatus? status)
SignOutCallback = Future Function(Auth<AuthKeys> authorizer)
UndoAccountCallback = Future<bool> Function(Auth<AuthKeys> authorizer)