EmailLinkAuthProvider class
An AuthProvider that allows to authenticate using a link that is being sent to the user's email.
- Inheritance
-
- Object
- AuthProvider<
EmailLinkAuthListener, AuthCredential> - EmailLinkAuthProvider
Constructors
- EmailLinkAuthProvider({required ActionCodeSettings actionCodeSettings, FirebaseDynamicLinks? dynamicLinks})
- An AuthProvider that allows to authenticate using a link that is being sent to the user's email.
Properties
- actionCodeSettings → ActionCodeSettings
-
A configuration of the dynamic link.
final
- auth ↔ FirebaseAuth
-
The
FirebaseAuth
instance used to perform authentication against. By default,FirebaseAuth.instance
is used.getter/setter pairinherited - authListener ↔ EmailLinkAuthListener
-
An instance of the AuthListener that is used to notify about the
current state of the authentication process.
getter/setter pairoverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- providerId → String
-
String identifer of the auth provider, for example:
'password'
,'phone'
or'google.com'
.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shouldUpgradeAnonymous → bool
-
Indicates whether the user should be upgraded and new credential should be
linked.
no setterinherited
Methods
-
awaitLink(
String email) → void -
Calls
FirebaseDynamicLinks
to receive the link and perform a sign in. Should be called after EmailLinkAuthListener.onLinkSent was called. -
findProvidersForEmail(
String email, [AuthCredential? credential]) → void -
Fetches available providers for the given
email
.inherited -
linkWithCredential(
AuthCredential credential) → void -
Links a provided
AuthCredential
with the currently signed in user account.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onCredentialReceived(
AuthCredential credential, AuthAction action) → void -
A method that is called when the user has successfully completed the
authentication process and decides what to do with the obtained
credential
.inherited -
sendLink(
String email) → void -
Sends a link to the
email
. -
signInWithCredential(
AuthCredential credential) → void -
Signs the user in with the provided
AuthCredential
.inherited -
supportsPlatform(
TargetPlatform platform) → bool -
Verifies that an AuthProvider is supported on a
platform
.override -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited