Provider for generating EmailAuthCredential.
Signature:
exportdeclareclassEmailAuthProviderimplementsAuthProviderImplements:AuthProvider
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| EMAIL_LINK_SIGN_IN_METHOD | static | 'emailLink' | Always set to SignInMethod.EMAIL_LINK. |
| EMAIL_PASSWORD_SIGN_IN_METHOD | static | 'password' | Always set to SignInMethod.EMAIL_PASSWORD. |
| PROVIDER_ID | static | 'password' | Always set to ProviderId.PASSWORD, even for email link. |
| providerId | "password" | Always set to ProviderId.PASSWORD, even for email link. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| credential(email, password) | static | Initialize an AuthCredential using an email and password. |
| credentialWithLink(email, emailLink) | static | Initialize an AuthCredential using an email and an email link after a sign in with email link operation. |
EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD
Always set to SignInMethod.EMAIL_LINK.
Signature:
staticreadonlyEMAIL_LINK_SIGN_IN_METHOD:'emailLink';EmailAuthProvider.EMAIL_PASSWORD_SIGN_IN_METHOD
Always set to SignInMethod.EMAIL_PASSWORD.
Signature:
staticreadonlyEMAIL_PASSWORD_SIGN_IN_METHOD:'password';EmailAuthProvider.PROVIDER_ID
Always set to ProviderId.PASSWORD, even for email link.
Signature:
staticreadonlyPROVIDER_ID:'password';EmailAuthProvider.providerId
Always set to ProviderId.PASSWORD, even for email link.
Signature:
readonlyproviderId:"password";EmailAuthProvider.credential()
Initialize an AuthCredential using an email and password.
Signature:
staticcredential(email:string,password:string):EmailAuthCredential;Parameters
| Parameter | Type | Description |
|---|---|---|
| string | Email address. | |
| password | string | User account password. |
Returns:
The auth provider credential.
Example 1
constauthCredential=EmailAuthProvider.credential(email,password);constuserCredential=awaitsignInWithCredential(auth,authCredential);Example 2
constuserCredential=awaitsignInWithEmailAndPassword(auth,email,password);EmailAuthProvider.credentialWithLink()
Initialize an AuthCredential using an email and an email link after a sign in with email link operation.
Signature:
staticcredentialWithLink(email:string,emailLink:string):EmailAuthCredential;Parameters
| Parameter | Type | Description |
|---|---|---|
| string | Email address. | |
| emailLink | string | Sign-in email link. |
Returns:
- The auth provider credential.
Example 1
constauthCredential=EmailAuthProvider.credentialWithLink(auth,email,emailLink);constuserCredential=awaitsignInWithCredential(auth,authCredential);Example 2
awaitsendSignInLinkToEmail(auth,email);// Obtain emailLink from user.constuserCredential=awaitsignInWithEmailLink(auth,email,emailLink);