MockFirebaseAuth class Null safety

Implemented types

Constructors

MockFirebaseAuth({bool signedIn = false, MockUser? mockUser, AuthExceptions? authExceptions, Map<String, List<String>>? signInMethodsForEmail})

Properties

app FirebaseApp
The FirebaseApp for this current Auth instance.
read / writeinherited
currentUser User?
Returns the current User if they are currently signed-in, or null if not.
read-onlyoverride
hashCode int
The hash code for this object.
read-onlyinherited
languageCode String?
The current Auth instance's language code.
read-onlyinherited
mockUser MockUser
write-only
onAuthStateChanged Stream<User>
read-only
pluginConstants Map
Returns any plugin constants this plugin app instance has initialized.
read-onlyinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
stateChangedStream Stream<User?>
read / write
stateChangedStreamController StreamController<User?>
final
tenantId String?
The current Auth instance's tenant ID.
read / writeinherited
userChangedStream Stream<User?>
read / write
userChangedStreamController StreamController<User?>
final

Methods

applyActionCode(String code) Future<void>
Applies a verification code sent to the user by email or other out-of-band mechanism.
inherited
authStateChanges() Stream<User?>
Notifies about changes to the user's sign-in state (such as sign-in or sign-out).
override
checkActionCode(String code) Future<ActionCodeInfo>
Checks a verification code sent to the user by email or other out-of-band mechanism.
inherited
confirmPasswordReset({required String code, required String newPassword}) Future<void>
Completes the password reset process, given a confirmation code and new password.
override
createUserWithEmailAndPassword({required String email, required String password}) Future<UserCredential>
Tries to create a new user account with the given email address and password.
override
fetchSignInMethodsForEmail(String email) Future<List<String>>
Returns a list of sign-in methods that can be used to sign in a given user (identified by its main email address).
override
getRedirectResult() Future<UserCredential>
Returns a UserCredential from the redirect-based sign-in flow.
inherited
idTokenChanges() Stream<User?>
Notifies about changes to the user's sign-in state (such as sign-in or sign-out) and also token refresh events.
inherited
Checks if an incoming link is a sign-in with email link.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
override
sendPasswordResetEmail({required String email, ActionCodeSettings? actionCodeSettings}) Future<void>
Sends a password reset email to the given email address.
override
sendSignInLinkToEmail({required String email, required ActionCodeSettings actionCodeSettings}) Future<void>
Sends a sign in with email link to provided email address.
override
setLanguageCode(String? languageCode) Future<void>
When set to null, the default Firebase Console language setting is applied.
inherited
setPersistence(Persistence persistence) Future<void>
Changes the current type of persistence on the current Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests.
inherited
setSettings({bool? appVerificationDisabledForTesting, String? userAccessGroup, String? phoneNumber, String? smsCode, bool? forceRecaptchaFlow}) Future<void>
Updates the current instance with the provided settings.
inherited
signInAnonymously() Future<UserCredential>
Asynchronously creates and becomes an anonymous user.
override
signInWithAuthProvider(AuthProvider provider) Future<UserCredential>
Signs in with an AuthProvider using native authentication flow. This is deprecated in favor of signInWithProvider().
@Deprecated('You should use signInWithProvider instead')inherited
signInWithCredential(AuthCredential? credential) Future<UserCredential>
Asynchronously signs in to Firebase with the given 3rd-party credentials (e.g. a Facebook login Access Token, a Google ID Token/Access Token pair, etc.) and returns additional identity provider data.
override
signInWithCustomToken(String token) Future<UserCredential>
Tries to sign in a user with a given custom token.
override
signInWithEmailAndPassword({required String email, required String password}) Future<UserCredential>
Attempts to sign in a user with the given email address and password.
override
Signs in using an email address and email sign-in link.
inherited
signInWithPhoneNumber(String phoneNumber, [RecaptchaVerifier? verifier]) Future<ConfirmationResult>
Starts a sign-in flow for a phone number.
override
signInWithPopup(AuthProvider provider) Future<UserCredential>
Authenticates a Firebase client using a popup-based OAuth authentication flow.
inherited
signInWithProvider(AuthProvider provider) Future<UserCredential>
Signs in with an AuthProvider using native authentication flow.
inherited
signInWithRedirect(AuthProvider provider) Future<void>
Authenticates a Firebase client using a full-page redirect flow.
inherited
signOut() Future<void>
Signs out the current user.
override
toString() String
A string representation of this object.
inherited
useAuthEmulator(String host, int port) Future<void>
Changes this instance to point to an Auth emulator running locally.
inherited
useEmulator(String origin) Future<void>
Changes this instance to point to an Auth emulator running locally.
@Deprecated('Will be removed in future release. ' 'Use useAuthEmulator().')inherited
userChanges() Stream<User?>
Notifies about changes to any user updates.
override
verifyPasswordResetCode(String code) Future<String>
Checks a password reset code sent to the user by email or other out-of-band mechanism.
override
verifyPhoneNumber({String? phoneNumber, PhoneMultiFactorInfo? multiFactorInfo, required PhoneVerificationCompleted verificationCompleted, required PhoneVerificationFailed verificationFailed, required PhoneCodeSent codeSent, required PhoneCodeAutoRetrievalTimeout codeAutoRetrievalTimeout, String? autoRetrievedSmsCodeForTesting, Duration timeout = const Duration(seconds: 30), int? forceResendingToken, Object? multiFactorSession}) Future<void>
Starts a phone number verification process for the given phone number.
override

Operators

operator ==(Object other) bool
The equality operator.
inherited