@capgo/capacitor-firebase-authentication

概述

Capacitor用于Firebase身份验证的插件。

核心功能

• applyActionCode - 使用邮箱收到的验证 code 进行验证。
• confirmPasswordReset - 完成密码重置流程。
• confirmVerificationCode - 完成手机号验证流程。
• createUserWithEmailAndPassword - 使用邮箱和密码创建新用户账户。如果新账户创建成功，用户会自动登录。

Public API

方法	描述
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-social-login 了解更多细节，请参阅 @capgo/capacitor-social-login, @capgo/capacitor-passkey 了解更多细节，请参阅 @capgo/capacitor-passkey, @capgo/capacitor-native-biometric 了解更多细节，请参阅 @capgo/capacitor-native-biometric, 双因素身份验证 了解更多细节，请参阅双因素身份验证, SSO (企业) [__CAPGO_KEEP_0__]在企业SSO（单点登录）中实现详细信息。