跳过内容

@capgo/capacitor-firebase-authentication

Capacitor Firebase 认证插件。

概述

概述

Capacitor Firebase 认证插件。

核心功能

功能:
  • applyActionCode - Applies a verification code sent to the user by email.
  • confirmPasswordReset - 完成密码重置流程。
  • confirmVerificationCode - 完成手机号验证流程。
  • createUserWithEmailAndPassword - 使用电子邮件和密码创建新用户帐户。如果新帐户创建成功,用户会自动登录。
方法描述
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.tscapacitor-firebase.