Firebase 认证 Capacitor 插件

使用 @capgo/capacitor-firebase-authentication

Capacitor 的 Firebase Authentication 插件

安装

bun add @capgo/capacitor-firebase-authentication
bunx cap sync

bunx cap sync 将插件的本机 code 复制到你的本机项目中。每次升级插件后都运行一次

导入

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

API概览

示例

applyActionCode()

通过电子邮件发送给用户的验证code。

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.applyActionCode({ oobCode: 'oob-code' });

confirmPasswordReset()

应用电子邮件中发送的验证__CAPGO_KEEP_0__。

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.confirmPasswordReset({
  oobCode: 'oob-code',
  newPassword: 'new-password',
});

confirmVerificationCode()

完成密码重置流程。

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.confirmVerificationCode({
  verificationId: 'phoneCodeSent',
  verificationCode: 'phoneCodeSent',
});
// The result holds sensitive values: use it without logging it.

createUserWithEmailAndPassword()

完成手机验证流程。

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.createUserWithEmailAndPassword({
  email: 'user@example.com',
  password: 'password',
});
// The result holds sensitive values: use it without logging it.

deleteUser()

使用电子邮件和密码创建新用户帐户。如果新帐户创建成功，用户会自动登录。

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.deleteUser();

fetchSignInMethodsForEmail()

删除并注销用户帐户。

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

const result = await FirebaseAuthentication.fetchSignInMethodsForEmail({ email: 'user@example.com' });
console.log(result);

上表列出了 59 个核心方法。监听器和版本助手，以及每个方法的完整契约，均在以下仓库中进行了文档记录： GitHub 仓库.

监听事件

addListener 返回一个句柄。调用 handle.remove() 当屏幕卸载时，或者 FirebaseAuthentication.removeAllListeners() 清除所有监听器。

完整参考

• GitHub 仓库
• 文档
• API 参考

继续使用 @capgo/capacitor-firebase-authentication

如果您正在使用 使用@capgo/capacitor-firebase-authentication 规划身份验证和帐户流程，连接它 @capgo/capacitor-社交登录 查看@capgo/capacitor-social-login的实现细节 @capgo/capacitor-passkey 查看@capgo/capacitor-passkey的实现细节 @capgo/capacitor-native-生物识别 查看@capgo/capacitor-native-biometric的实现细节 双因素身份验证 查看双因素身份验证的实现细节 SSO (企业) 查看SSO (企业)的实现细节