跳过内容

@capgo/capacitor-firebase-认证

Capacitor Firebase 认证

概述

概述

Capacitor Firebase 认证

从这里开始 applyActionCode() 和以下核心方法

平台支持

平台
context帮助注意
iOS是原生
Android是原生
Web否使用Capacitor.getPlatform()保护

核心功能

Core Capabilities
  • applyActionCode - 使用用户通过电子邮件接收的验证 code 进行验证。
  • confirmPasswordReset - 完成密码重置过程。
  • confirmVerificationCode - 完成电话号码验证过程。
  • createUserWithEmailAndPassword - 使用电子邮件和密码创建新用户帐户。如果新帐户已创建,则用户会自动登录。

Public API

公共API
方法描述
applyActionCode使用用户通过电子邮件接收的验证 code 进行验证。
confirmPasswordReset完成密码重置过程。
confirmVerificationCode完成电话号码验证过程。
createUserWithEmailAndPassword创建一个新的用户帐户,使用电子邮件和密码。如果新帐户创建成功,用户会自动登录。
deleteUser删除并注销用户。
fetchSignInMethodsForEmail获取一个电子邮件地址的登录方式。
getCurrentUser获取当前登录的用户。
getPendingAuthResult返回值 SignInResult 获取当前登录用户的Firebase Auth ID令牌。
getIdToken返回一个用来识别用户的Firebase服务的JSON Web令牌(JWT)。
getIdTokenResult从重定向式登录流程中获取。
getRedirectResult返回值 SignInResult 获取租户ID。
getTenantId检查一个链接是否是适合用于的电子邮件登录链接。
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-认证 用于规划身份验证和帐户流程,连接它与 @capgo/capacitor-社交登录 查看@capgo/capacitor-social-login的实现细节 @capgo/capacitor-passkey 查看@capgo/capacitor-passkey的实现细节 @capgo/capacitor原生生物识别 查看@capgo/capacitor-native-biometric的实现细节 两因素身份验证 查看两因素身份验证的实现细节,并且 SSO (企业) 为 SSO (企业) 的实现细节。