概述
概述部分Capacitor plugin for Firebase Authentication.
核心功能
核心功能部分applyActionCode- 使用邮箱发送给用户的验证 code 进行验证。confirmPasswordReset- 完成密码重置流程。confirmVerificationCode- 完成手机验证码验证流程。createUserWithEmailAndPassword- 使用邮箱和密码创建新用户账户。如果新账户创建成功,用户会自动登录。
Public API
Section titled “Public API”| Method | Description |
|---|---|
applyActionCode | 使用邮箱发送给用户的验证 code 进行验证。 |
confirmPasswordReset | 完成密码重置流程。 |
confirmVerificationCode | 完成手机验证码验证流程。 |
createUserWithEmailAndPassword | 使用邮箱和密码创建新用户账户。如果新账户创建成功,用户会自动登录。 |
deleteUser | 删除用户并注销. |
fetchSignInMethodsForEmail | 获取指定邮箱地址的登录方式. |
getCurrentUser | 获取当前登录用户. |
getPendingAuthResult | 返回 SignInResult 如果您的应用启动了一个Web登录流程,且在后台时操作系统清理了应用时. |
getIdToken | 获取当前登录用户的Firebase Auth ID Token. |
getIdTokenResult | 返回一个用来识别用户的Firebase服务的JSON Web Token (JWT)。 |
getRedirectResult | 返回 SignInResult 从重定向式登录流程中获取的. |
getTenantId | 获取租户ID. |
isSignInWithEmailLink | 检查一个链接是否是适合 signInWithEmailLink. |
linkWithApple | 将用户账户与Apple身份验证提供者关联。 |
linkWithEmailAndPassword | 绑定用户帐户与电子邮件身份验证提供者。 |
linkWithEmailLink | 绑定用户帐户与电子邮件身份验证提供者。 |
linkWithFacebook | 绑定用户帐户与Facebook身份验证提供者。 |
linkWithGameCenter | 绑定用户帐户与Game Center身份验证提供者。 |
linkWithGithub | 绑定用户帐户与GitHub身份验证提供者。 |
linkWithGoogle | 绑定用户帐户与Google身份验证提供者。 |
linkWithMicrosoft | 绑定用户帐户与Microsoft身份验证提供者。 |
linkWithOpenIdConnect | 绑定用户帐户与OpenID Connect身份验证提供者。 |
linkWithPhoneNumber | 绑定用户帐户与电话号码身份验证提供者。 |
linkWithPlayGames | 绑定用户帐户与Play Games身份验证提供者。 |
linkWithTwitter | 绑定用户帐户与Twitter身份验证提供者。 |
linkWithYahoo | 绑定用户帐户与Yahoo身份验证提供者。 |
reload | 重新加载用户账户数据,如果已登录。 |
revokeAccessToken | 撤销给定的访问令牌。目前仅支持Apple OAuth访问令牌。 |
sendEmailVerification | 向当前已登录用户发送验证邮件。 |
sendPasswordResetEmail | 发送密码重置邮件。 |
sendSignInLinkToEmail | 向指定邮箱的用户发送登录邮件链接。 |
setLanguageCode | 设置用于认证操作的用户界面语言code。 |
setPersistence | 设置当前保存的认证会话的持久化类型。 |
setTenantId | 设置租户ID。 |
signInAnonymously | 以匿名用户身份登录。 |
signInWithApple | 启动Apple登录流程。 |
signInWithCustomToken | 启动自定义令牌登录流程。 |
signInWithEmailAndPassword | 使用邮箱和密码启动登录流程。 |
signInWithEmailLink | 使用电子邮件和登录电子邮件链接登录。 |
signInWithFacebook | 开始Facebook登录流程。 |
signInWithGameCenter | 开始Game Center登录流程。 |
signInWithGithub | 开始GitHub登录流程。 |
signInWithGoogle | 开始Google登录流程。 |
signInWithMicrosoft | 开始Microsoft登录流程。 |
signInWithOpenIdConnect | 开始OpenID Connect登录流程。 |
signInWithPhoneNumber | 使用电话号码开始登录流程。 |
signInWithPlayGames | 开始Play Games登录流程。 |
signInWithTwitter | 开始Twitter登录流程。 |
signInWithYahoo | 开始Yahoo登录流程。 |
signOut | 开始注销流程。 |
unlink | 解除用户账户与服务提供者的关联。 |
updateEmail | 更新当前登录用户的电子邮件地址。 |
updatePassword | 更新当前登录用户的密码。 |
updateProfile | 更新用户的个人资料。 |
useAppLanguage | 将用户可见的语言code设为应用的默认语言。 |
useEmulator | 为应用配置与身份验证模拟器通信的功能。 |
verifyBeforeUpdateEmail | 在更新当前登录用户的电子邮件地址之前,验证新电子邮件地址。 |
checkAppTrackingTransparencyPermission | 检查应用的跟踪透明度当前状态。 |
requestAppTrackingTransparencyPermission | 打开系统对话框以授权应用跟踪透明度。 |
addListener | 监听用户登录状态的变化。 |
addListener | 监听当前登录用户的ID令牌变化。 |
addListener | 监听用户完成手机验证的事件。 |
addListener | 等待手机验证失败的结果 |
addListener | 等待手机验证的code |
removeAllListeners | 移除此插件的所有监听器 |
getPluginVersion | 获取此插件的版本 |
真实数据来源
源数据此参考资料是从 src/definitions.ts 在 capacitor-firebase.
继续从 @capgo/capacitor-firebase-authentication
继续从 @capgo/capacitor-firebase-authentication如果您正在使用 @capgo/capacitor-firebase-authentication 连接它以规划认证和帐户流程 @capgo/capacitor-social-login 查看@capgo/capacitor-social-login的实现细节 @capgo/capacitor-passkey 查看@capgo/capacitor-passkey的实现细节 @capgo/capacitor-native-biometric 查看@capgo/capacitor-native-biometric的实现细节 Two-factor authentication 查看Two-factor authentication的实现细节, SSO (Enterprise) 查看SSO (Enterprise)的实现细节。