跳过内容

@capgo/capacitor-firebase-authentication

Capacitor plugin for Firebase Authentication.

Capacitor plugin for Firebase Authentication.

核心功能

核心功能
  • applyActionCode - 使用用户通过电子邮件接收的验证 code 进行验证。
  • confirmPasswordReset - 完成密码重置流程。
  • confirmVerificationCode - 完成手机号验证流程。
  • createUserWithEmailAndPassword - 使用电子邮件和密码创建新用户帐户。如果新帐户创建成功,用户会自动登录。

公共 API

公共 API
方法描述
applyActionCode使用用户通过电子邮件接收的验证 code 进行验证。
confirmPasswordReset完成密码重置流程。
confirmVerificationCode完成手机号验证流程。
createUserWithEmailAndPassword创建一个新的用户账户,带有邮箱和密码。如果新账户创建成功,用户会自动登录。
deleteUser删除用户并注销登录。
fetchSignInMethodsForEmail获取一个邮箱地址的登录方式。
getCurrentUser获取当前登录的用户。
getPendingAuthResult如果您的应用程序启动了一个Web登录流程,且在后台时操作系统清理了应用程序。 SignInResult 获取当前登录用户的Firebase Auth ID Token。
getIdToken返回一个用来识别用户的Firebase服务的JSON Web Token (JWT)。
getIdTokenResult从重定向式登录流程中获取。
getRedirectResult获取租户ID。 SignInResult 检查一个链接是否是用于邮箱登录的链接,适合用于
getTenantId__CAPGO_KEEP_0__
isSignInWithEmailLink__CAPGO_KEEP_1__ signInWithEmailLink.
linkWithApple将用户账户与 Apple 身份验证提供者关联。
linkWithEmailAndPassword将用户账户与 Email 身份验证提供者关联。
linkWithEmailLink将用户账户与 Email 身份验证提供者关联。
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.tscapacitor-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, 双因素身份验证 了解更多细节,请参阅双因素身份验证, SSO (企业) 关于企业SSO (单点登录) 的实现细节。