# @capacitor-firebase/authentication 中文文档

规范地址：https://npmcn.com/package/%40capacitor-firebase/authentication/

版本：8\.6\.0
npm 元数据更新时间：2026-10-31T07:03:05.197Z
中文译文更新时间：2026-11-09T01:46:21.440Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capacitor-firebase/authentication
原文对照：https://npmcn.com/package/%40capacitor-firebase/authentication/?lang=original
项目主页：https://capawesome.io/
源码仓库：https://github.com/capawesome-team/capacitor-firebase

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：847 kB，78 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：firebase ^12\.6\.0，@capacitor/core \>=8\.0\.0
- 首次发布：2022-03-19T21:28:56.729Z
- 最新版本发布：2026-10-31T07:03:04.810Z
- 近 30 天下载量：635517（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：98（近 12 个月 15 个）

## 中文简介

在Android,iOS,和Web上用于Firebase认证的电容插件.

## 安装

```sh
npm install @capacitor-firebase/authentication
```

也可以使用：`pnpm add @capacitor-firebase/authentication`、`yarn add @capacitor-firebase/authentication`、`bun add @capacitor-firebase/authentication`

## README

# 电容火库认证插件

非官方电容插件 [Firebase 验证](https://firebase.google.com/docs/auth)\[^1\]

[![Try Capawesome Cloud free for 14 days — iOS builds without a Mac](https://capawesome.io/assets/banners/cloud-free-trial-capacitor-apps.png)](https://capawesome.io/)

## 使用大小写

Firebase认证插件一般用于处理一个应用程序的整个登录入流,例如:

-   **社会登录**:在本地用户中与Apple,Google,Facebook,微软,GitHub,Twitter,Yahoo,Play Games,或Game Center签名.
-   **基于电子邮件的认证**:用电子邮件和密码在用户中注册和签名,或发给他们无密码的登录链接.
-   **电话号码登录**:用发送到电话号码的短信码验证用户.
-   **来宾出入**: 让用户用匿名签名尝试您的应用程序, 并在稍后链接一个永久账户 .
-   **自定义后端**:用自定义的符号或OpenID Connection签名并取回ID符来认证请求到自己的后端.

## 兼容性

| 插件版本 | 电容版本 | 状态 |
| --- | --- | --- |
| 8.x.x (英语) | \>=8.x.x | 积极支持 |
| 7.x.x (中文(简体) ) | 7.x.x (中文(简体) ) | 折旧 |
| 6.x.x (中文(简体) ) | 6.x.x (中文(简体) ) | 折旧 |
| 5.x.x (中文(简体) ) | 5.x.x (中文(简体) ) | 折旧 |
| 1.x.x (中文(简体) ) | 4.x.x (中文(简体) ) | 折旧 |

## 指南

-   [Capacitor 的防火基地认证: 设置和最佳做法](https://capawesome.io/blog/capacitor-firebase-authentication-guide/): 此插件的登录流设置和最佳做法 .
-   [如何在电容App中使用火把](https://capawesome.io/blog/how-to-use-firebase-in-a-capacitor-app/):为什么签入通常是首个Firebase被接上电线的作品,以及它所生产的用户ID的基础上发展出来的.

## 安装

你可以用我们的 **AI 辅助设置** 以安装插件. 添加数据 [超级技能](https://github.com/capawesome-team/skills) 至您的 AI 工具,使用以下命令:

```bash
npx skills add capawesome-team/skills --skill capacitor-plugins
```

然后使用下列提示:

```
Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-firebase/authentication` plugin in my project.
```

如果你喜欢 **手动设置**,通过运行以下命令来安装插件,并遵循下面的平台特定指令:

```bash
npm install @capacitor-firebase/authentication firebase
npx cap sync
```

如果您还没有将 Firebase 添加到您的项目中([机器人](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#android) 编号 : [iOS系统](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#ios) 编号 : [网页](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#web)) (中文(简体) ).

打开 **iOS系统**,验证此功能是否包含在您的应用程序中 `AppDelegate.swift`数字 :

```swift
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
  return ApplicationDelegateProxy.shared.application(app, open: url, options: options)
}
```

**请注意**: 如果您在其中使用此插件 **iOS系统** 结合 `@capacitor-firebase/messaging`,然后在应用程序中添加以下内容: `AppDelegate.swift`数字 :

```diff
+ import FirebaseAuth

func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
+    if Auth.auth().canHandle(url) {
+      return true
+    }
    return ApplicationDelegateProxy.shared.application(app, open: url, options: options)
}
```

进一步的安装步骤取决于选定的认证方法:

-   [苹果签名 - 单位](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-apple.md)
    
-   [脸书签名 单位](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-facebook.md)
    
-   [游戏中心签名](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-game-center.md)
    
-   [GitHub 签名 -- 单位](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-github.md)
    
-   [谷歌签名 单位](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-google.md)
    
-   [微软签名](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-microsoft.md)
    
-   [OpenID 连接签名 - 单位](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-oidc.md)
    
-   [游戏签名 单位](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-play-games.md)
    
-   [推特签名- 单位](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-twitter.md)
    
-   [雅虎签了 单位](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-yahoo.md)
    
-   [匿名签名 单位](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-anonymous.md)
    
-   [电子邮件链接签名 - 单位](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-email-link.md)
    
-   [电话号码签名... 单位](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-phone.md)
    
-   [自定义托肯签名 -- 单位](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/setup-custom-token.md)
    

**请注意**:请注意,这个插件使用第三方SDK来提供本地登录. 这些SDK可以自行初始化并收集各种数据. 更多信息见 [第三方 SDKs](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/third-party-sdks.md)。 。 。 .

### iOS系统

#### Swift 软件包管理器

在您的 `capacitor.config.json` (或 `capacitor.config.ts`) 避免 [SwiftPM 软件包识别相撞](https://github.com/capawesome-team/capacitor-firebase/issues/959)数字 :

```json
{
  "experimental": {
    "ios": {
      "spm": {
        "packageOptions": {
          "@capacitor-firebase/authentication": {
            "symlink": true
          }
        }
      }
    }
  }
}
```

**请注意**目标 `packageOptions` 支持需要控制器 CLI **8.4.0+ (中文(简体) )**。 。 。 .

##### 软件包特性

GoogleSignIn 和 Facebook SDK 是可选的,默认通过 `Google` 财务报告和审定财务报表 `Facebook` 软件包特性。 如果您不使用这些提供者, 请禁用相应的特性, 以使 SDK 不连接到您的应用程序中 :

```json
{
  "experimental": {
    "ios": {
      "spm": {
        "swiftToolsVersion": "6.1",
        "packageTraits": {
          "@capacitor-firebase/authentication": ["Google"]
        }
      }
    }
  }
}
```

列出特征会明确替换默认,所以只启用您列出的特征. 以上例子保留了GoogleSignIn并排除了Facebook SDK. 使用 `Lite` 将两种情况排除在外:

```json
{
  "experimental": {
    "ios": {
      "spm": {
        "swiftToolsVersion": "6.1",
        "packageTraits": {
          "@capacitor-firebase/authentication": ["Lite"]
        }
      }
    }
  }
}
```

这些特征是相当于 `CapacitorFirebaseAuthentication/Google`, (中文(简体) ), `CapacitorFirebaseAuthentication/Facebook` 财务报告和审定财务报表 `CapacitorFirebaseAuthentication/Lite` 可可宝地亚种. 调用 SDK 被排除的供应商的登录方法 .

**请注意**: SPM 特性支持需要Capacitor CLI **8.3.0+ (中文(简体) )** 和 X 代码 **16.3+ (简体中文)** (Swift 6.1+) (英语).

## 配置

这些配置值是可用的 :

| Prop | 类型 | 说明 | 默认 | 自兹 |
| --- | --- | --- | --- | --- |
| **`authDomain`** | `string` | 配置您要使用的自定义认证域 。 仅供Android和iOS使用. |  | 7.3.0 (单位:千美元) |
| **`skipNativeAuth`** | `boolean` | 配置插件是否跳过本地认证 。 只有在您想要使用 Firebase JavaScript SDK 时才需要. 此配置选项对 Firebase 账户链接没有影响 . **注意插件可能在各个平台上表现不同.** 仅供Android和iOS使用. | `false` | 0.1.0 (中文(简体) ) |
| **`providers`** | `string[]` | 配置由插件加载的供应商 。 可能的数值 : `["apple.com", "facebook.com", "gc.apple.com", "github.com", "google.com", "microsoft.com", "playgames.google.com", "twitter.com", "yahoo.com", "phone"]` 仅供Android和iOS使用. | `[]` | 0.1.0 (中文(简体) ) |

### 实例

单位 `capacitor.config.json`数字 :

```json
{
  "plugins": {
    "FirebaseAuthentication": {
      "authDomain": undefined,
      "skipNativeAuth": false,
      "providers": ["apple.com", "facebook.com"]
    }
  }
}
```

单位 `capacitor.config.ts`数字 :

```ts
/// <reference types="@capacitor-firebase/authentication" />

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    FirebaseAuthentication: {
      authDomain: undefined,
      skipNativeAuth: false,
      providers: ["apple.com", "facebook.com"],
    },
  },
};

export default config;
```

## 火基地 JavaScript SDK

[给](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/authentication/docs/firebase-js-sdk.md) 您可以找到如何使用 Firebase JS SDK 插件的信息.

## 演示

这里有一个实例: [robingenz/电容器 -- -- 消防基地 -- -- 校正 -- -- 演示](https://github.com/robingenz/capacitor-firebase-authentication-demo)

## 启动模板

以下启动模板可供使用:

-   [角起火点](https://ionstarter.dev/)

## 使用量

以下例子显示如何用电子邮件和密码签名,社交供应商,电话号码,电子邮件链接,匿名,自定义的代号,以及如何管理当前用户,重置密码,验证和更新电子邮件地址,设置语言,签名,删除用户,并使用Firebase模拟器.

### 签名并用电子邮件和密码签名

创建一个有电子邮件和密码的新用户账户,并用这些证书签名用户:

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

const createUserWithEmailAndPassword = async () => {
  const result = await FirebaseAuthentication.createUserWithEmailAndPassword({
    email: 'mail@example.com',
    password: '1234',
  });
  return result.user;
};

const signInWithEmailAndPassword = async () => {
  const result = await FirebaseAuthentication.signInWithEmailAndPassword({
    email: 'mail@example.com',
    password: '1234',
  });
  return result.user;
};
```

### 跟社工签约

在用户中与苹果,谷歌,Facebook,GitHub,微软,Twitter或雅虎等供应商在本地签名. 每一个提供者都要求设置步骤 [安装](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-installation) 节。 Game Center的签入仅在iOS上提供,而Play Games的签入仅在Android上提供:

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

const signInWithApple = async () => {
  const result = await FirebaseAuthentication.signInWithApple();
  return result.user;
};

const signInWithFacebook = async () => {
  const result = await FirebaseAuthentication.signInWithFacebook();
  return result.user;
};

const signInWithGameCenter = async () => {
  const result = await FirebaseAuthentication.signInWithGameCenter();
  return result.user;
};

const signInWithGithub = async () => {
  const result = await FirebaseAuthentication.signInWithGithub();
  return result.user;
};

const signInWithGoogle = async () => {
  const result = await FirebaseAuthentication.signInWithGoogle();
  return result.user;
};

const signInWithMicrosoft = async () => {
  const result = await FirebaseAuthentication.signInWithMicrosoft();
  return result.user;
};

const signInWithPlayGames = async () => {
  const result = await FirebaseAuthentication.signInWithPlayGames();
  return result.user;
};

const signInWithTwitter = async () => {
  const result = await FirebaseAuthentication.signInWithTwitter();
  return result.user;
};

const signInWithYahoo = async () => {
  const result = await FirebaseAuthentication.signInWithYahoo();
  return result.user;
};
```

### 用电话号码签名

启动电话号码登录流程,向用户发送短信码,并用 `confirmVerificationCode(...)`。仅在Android和iOS上提供:

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

const signInWithPhoneNumber = async () => {
  return new Promise(async resolve => {
    // Attach `phoneCodeSent` listener to be notified as soon as the SMS is sent
    await FirebaseAuthentication.addListener('phoneCodeSent', async event => {
      // Ask the user for the SMS code
      const verificationCode = window.prompt(
        'Please enter the verification code that was sent to your mobile device.',
      );
      // Confirm the verification code
      const result = await FirebaseAuthentication.confirmVerificationCode({
        verificationId: event.verificationId,
        verificationCode,
      });
      resolve(result.user);
    });
    // Attach `phoneVerificationCompleted` listener to be notified if phone verification could be finished automatically
    await FirebaseAuthentication.addListener(
      'phoneVerificationCompleted',
      async event => {
        resolve(event.result.user);
      },
    );
    // Start sign in with phone number and send the SMS
    await FirebaseAuthentication.signInWithPhoneNumber({
      phoneNumber: '123456789',
    });
  });
};
```

### 用电子邮件链接签名

向用户的电子邮件地址发送无密码的登录链接, 并在链接打开后完成登录 :

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

const sendSignInLinkToEmail = async () => {
  const email = 'mail@example.com';
  await FirebaseAuthentication.sendSignInLinkToEmail({
    email,
    actionCodeSettings: {
      // URL you want to redirect back to. The domain (www.example.com) for this
      // URL must be in the authorized domains list in the Firebase Console.
      url: 'https://www.example.com/finishSignUp?cartId=1234',
      // This must be true.
      handleCodeInApp: true,
      iOS: {
        bundleId: 'com.example.ios',
      },
      android: {
        packageName: 'com.example.android',
        installApp: true,
        minimumVersion: '12',
      },
      dynamicLinkDomain: 'example.page.link',
    },
  });
  // The link was successfully sent. Inform the user.
  // Save the email locally so you don't need to ask the user for it again
  // if they open the link on the same device.
  window.localStorage.setItem('emailForSignIn', email);
};

const signInWithEmailLink = async () => {
  // Get the email if available. This should be available if the user completes
  // the flow on the same device where they started it.
  const emailLink = window.location.href;
  // Confirm the link is a sign-in with email link.
  const { isSignInWithEmailLink } =
    await FirebaseAuthentication.isSignInWithEmailLink({
      emailLink,
    });
  if (!isSignInWithEmailLink) {
    return;
  }
  let email = window.localStorage.getItem('emailForSignIn');
  if (!email) {
    // User opened the link on a different device. To prevent session fixation
    // attacks, ask the user to provide the associated email again.
    email = window.prompt('Please provide your email for confirmation.');
  }
  // The client SDK will parse the code from the link for you.
  const result = await FirebaseAuthentication.signInWithEmailLink({
    email,
    emailLink,
  });
  // Clear email from storage.
  window.localStorage.removeItem('emailForSignIn');
  return result.user;
};
```

### 匿名签名

在用户中匿名签名, 例如让用户在创建账户前尝试您的应用程序 :

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

const signInAnonymously = async () => {
  const result = await FirebaseAuthentication.signInAnonymously();
  return result.user;
};
```

### 用自定义的符号或 OpenID 连接签名

用自定义的符号验证您自己的后端, 或使用任何 OpenID 连接提供者 :

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

const signInWithCustomToken = async () => {
  const result = await FirebaseAuthentication.signInWithCustomToken({
    token: '1234',
  });
  return result.user;
};

const signInWithOpenIdConnect = async () => {
  const result = await FirebaseAuthentication.signInWithOpenIdConnect({
    providerId: 'oidc.example.com',
  });
  return result.user;
};
```

### 获取当前用户和标识符

获取当前已签名的用户,他们的ID令牌,或者等待认证操作的结果. 这个 `getPendingAuthResult()` 方法只在Android上可用:

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

const getCurrentUser = async () => {
  const result = await FirebaseAuthentication.getCurrentUser();
  return result.user;
};

const getIdToken = async () => {
  const currentUser = await getCurrentUser();
  if (!currentUser) {
    return;
  }
  const result = await FirebaseAuthentication.getIdToken();
  return result.token;
};

const getPendingAuthResult = async () => {
  const result = await FirebaseAuthentication.getPendingAuthResult();
  return result.user;
};
```

### 发送和确认密码重置

向用户发送密码重置电子邮件,并用收到的出带码确认密码重置:

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

const sendPasswordResetEmail = async () => {
  await FirebaseAuthentication.sendPasswordResetEmail({
    email: 'mail@example.com',
  });
};

const confirmPasswordReset = async () => {
  await FirebaseAuthentication.confirmPasswordReset({
    oobCode: '1234',
    newPassword: '4321',
  });
};
```

### 校验用户的电子邮件地址

向当前登录的用户发送一个验证邮件, 并应用收到的带外代码 :

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

const sendEmailVerification = async () => {
  const currentUser = await getCurrentUser();
  if (!currentUser) {
    return;
  }
  await FirebaseAuthentication.sendEmailVerification();
};

const applyActionCode = async () => {
  await FirebaseAuthentication.applyActionCode({ oobCode: '1234' });
};
```

### 更新用户的电子邮件或密码

更新当前登录用户的电子邮件地址或密码 。 与 `verifyBeforeUpdateEmail(...)`,新的电子邮件地址在更新前会核实:

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

const updateEmail = async () => {
  const currentUser = await getCurrentUser();
  if (!currentUser) {
    return;
  }
  await FirebaseAuthentication.updateEmail({
    newEmail: 'new.mail@example.com',
  });
};

const verifyBeforeUpdateEmail = async () => {
  const currentUser = await getCurrentUser();
  if (!currentUser) {
    return;
  }
  await FirebaseAuthentication.verifyBeforeUpdateEmail({
    newEmail: 'new.mail@example.com',
    actionCodeSettings: {
      url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
      iOS: {
        bundleId: 'com.example.ios'
      },
      android: {
        packageName: 'com.example.android',
        installApp: true,
        minimumVersion: '12'
      },
      handleCodeInApp: true
    }
  });
};

const updatePassword = async () => {
  const currentUser = await getCurrentUser();
  if (!currentUser) {
    return;
  }
  await FirebaseAuthentication.updatePassword({
    newPassword: '4321',
  });
};
```

### 查找电子邮件的登录方法

获取电子邮件地址可用的登录方法 :

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

const fetchSignInMethodsForEmail = async () => {
  const result = await FirebaseAuthentication.fetchSignInMethodsForEmail({
    email: 'mail@example.tld',
  });
  return result.signInMethods;
};
```

### 设置语言

设定要使用的语言代码, 或者应用当前应用语言 :

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

const setLanguageCode = async () => {
  await FirebaseAuthentication.setLanguageCode({ languageCode: 'en-US' });
};

const useAppLanguage = async () => {
  await FirebaseAuthentication.useAppLanguage();
};
```

### 签名并删除用户

签名当前用户或永久删除用户账户 :

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

const signOut = async () => {
  await FirebaseAuthentication.signOut();
};

const deleteUser = async () => {
  await FirebaseAuthentication.deleteUser();
};
```

### 使用火地模拟器

将插件连接到本地端 [火地模拟器](https://firebase.google.com/docs/emulator-suite) 开发过程中的实例:

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

const useEmulator = async () => {
  await FirebaseAuthentication.useEmulator({
    host: '10.0.2.2',
    port: 9099,
  });
};
```

## API 密码

-   [`applyActionCode(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-applyactioncode)
-   [`confirmPasswordReset(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-confirmpasswordreset)
-   [`confirmVerificationCode(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-confirmverificationcode)
-   [`createUserWithEmailAndPassword(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-createuserwithemailandpassword)
-   [`deleteUser()`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-deleteuser)
-   [`fetchSignInMethodsForEmail(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-fetchsigninmethodsforemail)
-   [`getCurrentUser()`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-getcurrentuser)
-   [`getPendingAuthResult()`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-getpendingauthresult)
-   [`getIdToken(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-getidtoken)
-   [`getIdTokenResult(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-getidtokenresult)
-   [`getRedirectResult()`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-getredirectresult)
-   [`getTenantId()`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-gettenantid)
-   [`isSignInWithEmailLink(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-issigninwithemaillink)
-   [`linkWithApple(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithapple)
-   [`linkWithEmailAndPassword(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithemailandpassword)
-   [`linkWithEmailLink(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithemaillink)
-   [`linkWithFacebook(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithfacebook)
-   [`linkWithGameCenter(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithgamecenter)
-   [`linkWithGithub(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithgithub)
-   [`linkWithGoogle(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithgoogle)
-   [`linkWithMicrosoft(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithmicrosoft)
-   [`linkWithOpenIdConnect(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithopenidconnect)
-   [`linkWithPhoneNumber(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithphonenumber)
-   [`linkWithPlayGames(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithplaygames)
-   [`linkWithTwitter(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithtwitter)
-   [`linkWithYahoo(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithyahoo)
-   [`reload()`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-reload)
-   [`revokeAccessToken(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-revokeaccesstoken)
-   [`sendEmailVerification(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-sendemailverification)
-   [`sendPasswordResetEmail(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-sendpasswordresetemail)
-   [`sendSignInLinkToEmail(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-sendsigninlinktoemail)
-   [`setLanguageCode(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-setlanguagecode)
-   [`setPersistence(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-setpersistence)
-   [`setTenantId(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-settenantid)
-   [`signInAnonymously()`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinanonymously)
-   [`signInWithApple(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithapple)
-   [`signInWithCustomToken(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithcustomtoken)
-   [`signInWithEmailAndPassword(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithemailandpassword)
-   [`signInWithEmailLink(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithemaillink)
-   [`signInWithFacebook(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithfacebook)
-   [`signInWithGameCenter(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithgamecenter)
-   [`signInWithGithub(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithgithub)
-   [`signInWithGoogle(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithgoogle)
-   [`signInWithMicrosoft(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithmicrosoft)
-   [`signInWithOpenIdConnect(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithopenidconnect)
-   [`signInWithPhoneNumber(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithphonenumber)
-   [`signInWithPlayGames(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithplaygames)
-   [`signInWithTwitter(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithtwitter)
-   [`signInWithYahoo(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithyahoo)
-   [`signOut()`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signout)
-   [`unlink(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-unlink)
-   [`updateEmail(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-updateemail)
-   [`updatePassword(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-updatepassword)
-   [`updateProfile(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-updateprofile)
-   [`useAppLanguage()`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-useapplanguage)
-   [`useEmulator(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-useemulator)
-   [`verifyBeforeUpdateEmail(...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-verifybeforeupdateemail)
-   [`checkAppTrackingTransparencyPermission()`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-checkapptrackingtransparencypermission)
-   [`requestAppTrackingTransparencyPermission()`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-requestapptrackingtransparencypermission)
-   [`addListener('authStateChange', ...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-addlistenerauthstatechange-)
-   [`addListener('idTokenChange', ...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-addlisteneridtokenchange-)
-   [`addListener('phoneVerificationCompleted', ...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-addlistenerphoneverificationcompleted-)
-   [`addListener('phoneVerificationFailed', ...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-addlistenerphoneverificationfailed-)
-   [`addListener('phoneCodeSent', ...)`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-addlistenerphonecodesent-)
-   [`removeAllListeners()`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-removealllisteners)
-   [接口](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-type-aliases)
-   [数字](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-enums)

### 应用动作代码(...)

```typescript
applyActionCode(options: ApplyActionCodeOptions) => Promise<void>
```

应用通过电子邮件发送给用户的校验码 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[ApplyActionCodeOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-applyactioncodeoptions)` |

**自:** 0.2.2 (中文(简体) )

* * *

### 确认 Password 重置(...)

```typescript
confirmPasswordReset(options: ConfirmPasswordResetOptions) => Promise<void>
```

完成密码重置进程.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[ConfirmPasswordResetOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-confirmpasswordresetoptions)` |

**自:** 0.2.2 (中文(简体) )

* * *

### 确认验证码(...)

```typescript
confirmVerificationCode(options: ConfirmVerificationCodeOptions) => Promise<SignInResult>
```

完成电话号码验证程序.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[ConfirmVerificationCodeOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-confirmverificationcodeoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 5.0.0 (单位:千美元)

* * *

### 创建 UserWith EmailAndPassword (.)

```typescript
createUserWithEmailAndPassword(options: CreateUserWithEmailAndPasswordOptions) => Promise<SignInResult>
```

创建一个有电子邮件和密码的新用户账户. 如果创建了新账户,用户会自动签名.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[CreateUserWithEmailAndPasswordOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-createuserwithemailandpasswordoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 0.2.2 (中文(简体) )

* * *

### 删除用户( )

```typescript
deleteUser() => Promise<void>
```

删除并签名出用户.

**自:** 1.3.0 (单位:千美元)

* * *

### 获取 SignInMethods ForEmail (...)

```typescript
fetchSignInMethodsForEmail(options: FetchSignInMethodsForEmailOptions) => Promise<FetchSignInMethodsForEmailResult>
```

获取电子邮件地址的登录方法.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[FetchSignInMethodsForEmailOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-fetchsigninmethodsforemailoptions)` |

**回返情况:** `Promise<[FetchSignInMethodsForEmailResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-fetchsigninmethodsforemailresult)>`

**自:** 6.0.0 (单位:千美元)

* * *

### 获取当前用户( C)

```typescript
getCurrentUser() => Promise<GetCurrentUserResult>
```

获取当前已签名的用户.

**回返情况:** `Promise<[GetCurrentUserResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-getcurrentuserresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 获得PendingAuthResult ()

```typescript
getPendingAuthResult() => Promise<SignInResult>
```

返回 [`SignInResult`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult) 如果您的应用程序启用了网络登录流, 而操作系统则在背景中清理应用程序 .

仅供Android使用.

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 6.0.0 (单位:千美元)

* * *

### 获取 IdToken (...)

```typescript
getIdToken(options?: GetIdTokenOptions | undefined) => Promise<GetIdTokenResult>
```

为当前登录的用户获取 Firebase Auth ID Token .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[GetIdTokenOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-getidtokenoptions)` |

**回返情况:** `Promise<[GetIdTokenResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-getidtokenresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 获取 IdToken Result (...)

```typescript
getIdTokenResult(options?: GetIdTokenResultOptions | undefined) => Promise<GetIdTokenResultResult>
```

返回用于识别用户身份的已解编的JSON Web Token(JWT)到Firebase服务.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[GetIdTokenResultOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-getidtokenresultoptions)` |

**回返情况:** `Promise<[GetIdTokenResultResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-getidtokenresultresult)>`

**自:** 7.4.0 (单位:千美元)

* * *

### 获取直接结果( C)

```typescript
getRedirectResult() => Promise<SignInResult>
```

返回 [`SignInResult`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult) 从基于方向的登录流.

如果登录失败, 则出现出错 . 如果没有调试方向操作, 请返回 a [`SignInResult`](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult) 与无效用户.

仅供Web使用.

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.3.0 (单位:千美元)

* * *

### 获取 TenantId ()

```typescript
getTenantId() => Promise<GetTenantIdResult>
```

拿房客身份证来.

**回返情况:** `Promise<[GetTenantIdResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-gettenantidresult)>`

**自:** 1.1.0 国家

* * *

### 是SignIn With EmailLink (...) 的缩写

```typescript
isSignInWithEmailLink(options: IsSignInWithEmailLinkOptions) => Promise<IsSignInWithEmailLinkResult>
```

检查一个进入的链接是否是带有适合的电子邮件链接的登录 `signInWithEmailLink`。 。 。 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[IsSignInWithEmailLinkOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-issigninwithemaillinkoptions)` |

**回返情况:** `Promise<[IsSignInWithEmailLinkResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-issigninwithemaillinkresult)>`

**自:** 1.1.0 国家

* * *

### 链接与 Apple (...)

```typescript
linkWithApple(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>
```

将用户账户与苹果认证提供者链接.

用户必须在原地层登录. 这个 `skipNativeAuth` 配置选项在此没有效果 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.1.0 国家

* * *

### 链接与电子邮件AndPassword (...)

```typescript
linkWithEmailAndPassword(options: LinkWithEmailAndPasswordOptions) => Promise<LinkResult>
```

将用户账户与电子邮件认证提供者链接.

用户必须在原地层登录. 这个 `skipNativeAuth` 配置选项在此没有效果 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[LinkWithEmailAndPasswordOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithemailandpasswordoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.1.0 国家

* * *

### 链接与电子邮件链接(...)

```typescript
linkWithEmailLink(options: LinkWithEmailLinkOptions) => Promise<LinkResult>
```

将用户账户与电子邮件认证提供者链接.

用户必须在原地层登录. 这个 `skipNativeAuth` 配置选项在此没有效果 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[LinkWithEmailLinkOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-linkwithemaillinkoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.1.0 国家

* * *

### 链接到脸书(...)

```typescript
linkWithFacebook(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>
```

链接用户账户与 Facebook 认证提供者 .

用户必须在原地层登录. 这个 `skipNativeAuth` 配置选项在此没有效果 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.1.0 国家

* * *

### 链接到 GameCenter (...)

```typescript
linkWithGameCenter(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>
```

将用户账户链接到游戏中心认证提供者.

用户必须在原地层登录. 这个 `skipNativeAuth` 配置选项在此没有效果 .

仅供iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.3.0 (单位:千美元)

* * *

### 链接到 Github (...)

```typescript
linkWithGithub(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>
```

将用户账户链接到 GitHub 认证提供者 .

用户必须在原地层登录. 这个 `skipNativeAuth` 配置选项在此没有效果 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.1.0 国家

* * *

### 链接到 Google (...)

```typescript
linkWithGoogle(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>
```

将用户账户与Google认证提供者链接.

用户必须在原地层登录. 这个 `skipNativeAuth` 配置选项在此没有效果 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.1.0 国家

* * *

### 链接微软(...)

```typescript
linkWithMicrosoft(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>
```

将用户账户与微软认证提供者链接.

用户必须在原地层登录. 这个 `skipNativeAuth` 配置选项在此没有效果 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.1.0 国家

* * *

### 链接与 OpenIdConnect (...)

```typescript
linkWithOpenIdConnect(options: LinkWithOpenIdConnectOptions) => Promise<LinkResult>
```

用 OpenID 连接提供者链接用户账户.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOpenIdConnectOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithopenidconnectoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 6.1.0 (中文(简体) )

* * *

### 链接与 Phone 数字(...)

```typescript
linkWithPhoneNumber(options: LinkWithPhoneNumberOptions) => Promise<void>
```

连接用户账户与电话号码认证提供者.

用户必须在原地层登录. 这个 `skipNativeAuth` 配置选项在此没有效果 .

使用 `phoneVerificationCompleted` 核查结束后通知听众. 使用 `phoneVerificationFailed` 当验证失败时, 要通知的听众 . 使用 `phoneCodeSent` 监听者获取验证码.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithPhoneNumberOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithphonenumberoptions)` |

**自:** 1.1.0 国家

* * *

### 链接与 PlayGames (...)

```typescript
linkWithPlayGames(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>
```

链接用户账户与 PlayGames 认证提供者.

用户必须在原地层登录. 这个 `skipNativeAuth` 配置选项在此没有效果 .

仅供Android使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.1.0 国家

* * *

### 链接到 Twitter (...)

```typescript
linkWithTwitter(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>
```

链接用户账户与Twitter认证提供者.

用户必须在原地层登录. 这个 `skipNativeAuth` 配置选项在此没有效果 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.1.0 国家

* * *

### 链接与 Yahoo (...)

```typescript
linkWithYahoo(options?: SignInWithOAuthOptions | undefined) => Promise<LinkResult>
```

链接用户账户与 Yahoo 认证提供者.

用户必须在原地层登录. 这个 `skipNativeAuth` 配置选项在此没有效果 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.1.0 国家

* * *

### 重新装入( c)

```typescript
reload() => Promise<void>
```

重新装入用户账户数据, 如果签名的话 .

**自:** 1.3.0 (单位:千美元)

* * *

### 撤销 AccessToken (...)

```typescript
revokeAccessToken(options: RevokeAccessTokenOptions) => Promise<void>
```

撤销给定的访问符 。 目前只支持Apple OAuth访问符.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[RevokeAccessTokenOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-revokeaccesstokenoptions)` |

**自:** 6.1.0 (中文(简体) )

* * *

### 发送电子邮件验证(...)

```typescript
sendEmailVerification(options?: SendEmailVerificationOptions | undefined) => Promise<void>
```

向当前在用户中签名的用户发送验证邮件 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SendEmailVerificationOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-sendemailverificationoptions)` |

**自:** 0.2.2 (中文(简体) )

* * *

### 发送 Password 重置邮件(...)

```typescript
sendPasswordResetEmail(options: SendPasswordResetEmailOptions) => Promise<void>
```

发送密码重置邮件 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SendPasswordResetEmailOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-sendpasswordresetemailoptions)` |

**自:** 0.2.2 (中文(简体) )

* * *

### 发送SignInLink To电子邮件(...)

```typescript
sendSignInLinkToEmail(options: SendSignInLinkToEmailOptions) => Promise<void>
```

用指定的电子邮件向用户发送签名电子邮件链接 .

要完成电子邮件链接的签名, 请打电话 `signInWithEmailLink` 的电子邮件地址和电子邮件链接.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SendSignInLinkToEmailOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-sendsigninlinktoemailoptions)` |

**自:** 1.1.0 国家

* * *

### 语言代码(...)

```typescript
setLanguageCode(options: SetLanguageCodeOptions) => Promise<void>
```

设置用于认证操作的用户界面语言代码.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SetLanguageCodeOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-setlanguagecodeoptions)` |

**自:** 0.1.0 (中文(简体) )

* * *

### 设置持续(...)

```typescript
setPersistence(options: SetPersistenceOptions) => Promise<void>
```

设置当前保存的认证会话的持久性类型 .

仅供Web使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SetPersistenceOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-setpersistenceoptions)` |

**自:** 5.2.0 (中文(简体) )

* * *

### 设置 TenantId (...)

```typescript
setTenantId(options: SetTenantIdOptions) => Promise<void>
```

确定租户身份.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SetTenantIdOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-settenantidoptions)` |

**自:** 1.1.0 国家

* * *

### 匿名签名 ()

```typescript
signInAnonymously() => Promise<SignInResult>
```

作为匿名用户签名.

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.1.0 国家

* * *

### 签名InWithApple (...)

```typescript
signInWithApple(options?: SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

启动 Apple 登录流量 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 签名 InWithCustom Token (...)

```typescript
signInWithCustomToken(options: SignInWithCustomTokenOptions) => Promise<SignInResult>
```

启动自定义托肯签名流程.

这种方法不能与 `skipNativeAuth` (原始内容存档于2019-10-12). Android and iOS. 在这种情况下,你必须使用 `signInWithCustomToken` 直接使用 Firebase JS SDK 接口.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithCustomTokenOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithcustomtokenoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 在电子邮件中签名 AndPassword (...)

```typescript
signInWithEmailAndPassword(options: SignInWithEmailAndPasswordOptions) => Promise<SignInResult>
```

使用电子邮件和密码启动登录流程.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithEmailAndPasswordOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithemailandpasswordoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 0.2.2 (中文(简体) )

* * *

### 在电子邮件链接中签名(...)

```typescript
signInWithEmailLink(options: SignInWithEmailLinkOptions) => Promise<SignInResult>
```

使用电子邮件和签名电子邮件链接签名 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithEmailLinkOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithemaillinkoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.1.0 国家

* * *

### 使用脸书签名(...)

```typescript
signInWithFacebook(options?: SignInWithFacebookOptions | undefined) => Promise<SignInResult>
```

启动脸书登录流程 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithFacebookOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithfacebookoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 签入 Game 中心(...)

```typescript
signInWithGameCenter(options?: SignInWithOAuthOptions | SignInOptions | undefined) => Promise<SignInResult>
```

启动游戏中心的登录流程.

仅供iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions) | [SignInOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 1.3.0 (单位:千美元)

* * *

### 签名 InWithub (...)

```typescript
signInWithGithub(options?: SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

启动 GitHub 登录流量 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 使用 Google 签名(...)

```typescript
signInWithGoogle(options?: SignInWithGoogleOptions | undefined) => Promise<SignInResult>
```

启动Google登录流量.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithGoogleOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithgoogleoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 签名InWith Microsoft (...)

```typescript
signInWithMicrosoft(options?: SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

启动微软的登录流.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 在 OpenIdConnect 中签名(...)

```typescript
signInWithOpenIdConnect(options: SignInWithOpenIdConnectOptions) => Promise<SignInResult>
```

启动 OpenID 连接签名流.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOpenIdConnectOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithopenidconnectoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 6.1.0 (中文(简体) )

* * *

### 签名 InWithPhone 数字(...)

```typescript
signInWithPhoneNumber(options: SignInWithPhoneNumberOptions) => Promise<void>
```

使用电话号码启动登录流.

使用 `phoneVerificationCompleted` 核查结束后通知听众. 使用 `phoneVerificationFailed` 当验证失败时, 要通知的听众 . 使用 `phoneCodeSent` 监听者获取验证码.

仅供Android和iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithPhoneNumberOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithphonenumberoptions)` |

**自:** 0.1.0 (中文(简体) )

* * *

### 签入 PlayGames (...)

```typescript
signInWithPlayGames(options?: SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

启动游戏游戏的登录流程.

仅供Android使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 签名 With Twitter (...)

```typescript
signInWithTwitter(options?: SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

启动推特登录流量.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 签入 Yahoo (...)

```typescript
signInWithYahoo(options?: SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

启动"雅虎"的签入流.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SignInWithOAuthOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinwithoauthoptions)` |

**回返情况:** `Promise<[SignInResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-signinresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 符号输出( C)

```typescript
signOut() => Promise<void>
```

启动出牌流.

**自:** 0.1.0 (中文(简体) )

* * *

### 取消链接(...)

```typescript
unlink(options: UnlinkOptions) => Promise<UnlinkResult>
```

从用户账户中取消一个提供者的链接.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[UnlinkOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-unlinkoptions)` |

**回返情况:** `Promise<[UnlinkResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-unlinkresult)>`

**自:** 1.1.0 国家

* * *

### 更新电子邮件(...)

```typescript
updateEmail(options: UpdateEmailOptions) => Promise<void>
```

更新当前用户签名的电子邮件地址.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[UpdateEmailOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-updateemailoptions)` |

**自:** 0.1.0 (中文(简体) )

* * *

### 更新 Password (.)

```typescript
updatePassword(options: UpdatePasswordOptions) => Promise<void>
```

更新当前用户签名的密码.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[UpdatePasswordOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-updatepasswordoptions)` |

**自:** 0.1.0 (中文(简体) )

* * *

### 更新Profile (...)

```typescript
updateProfile(options: UpdateProfileOptions) => Promise<void>
```

更新用户的配置数据.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[UpdateProfileOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-updateprofileoptions)` |

**自:** 1.3.0 (单位:千美元)

* * *

### 使用 AppLangage () 语言

```typescript
useAppLanguage() => Promise<void>
```

设定用户界面语言代码为默认的app语言.

**自:** 0.1.0 (中文(简体) )

* * *

### 使用计算器(...)

```typescript
useEmulator(options: UseEmulatorOptions) => Promise<void>
```

您的应用程序可以和认证模拟器交谈 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[UseEmulatorOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-useemulatoroptions)` |

**自:** 0.2.0 (中文(简体) )

* * *

### 校验更新前的电子邮件(...)

```typescript
verifyBeforeUpdateEmail(options: VerifyBeforeUpdateEmailOptions) => Promise<void>
```

在更新当前用户签名的电子邮件地址之前验证新的电子邮件地址 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[VerifyBeforeUpdateEmailOptions](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-verifybeforeupdateemailoptions)` |

**自:** 6.3.0 (单位:千美元)

* * *

### 追踪透明性

```typescript
checkAppTrackingTransparencyPermission() => Promise<CheckAppTrackingTransparencyPermissionResult>
```

检查应用程序跟踪透明度的现状.

仅在iOS上可用.

**回返情况:** `Promise<[CheckAppTrackingTransparencyPermissionResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-checkapptrackingtransparencypermissionresult)>`

**自:** 7.2.0 联合国

* * *

### 追踪透明性

```typescript
requestAppTrackingTransparencyPermission() => Promise<RequestAppTrackingTransparencyPermissionResult>
```

打开系统对话框以授权应用跟踪透明度 .

**请注意:** 用户可能已禁用设备设置中的跟踪请求,参见 [苹果的文档](https://support.apple.com/guide/iphone/iph4f4cbd242/ios)。 。 。 .

仅在iOS上可用.

**回返情况:** `Promise<[CheckAppTrackingTransparencyPermissionResult](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-checkapptrackingtransparencypermissionresult)>`

**自:** 7.2.0 联合国

* * *

### 添加倾听器( “ 自动状态变化 ” ,...)

```typescript
addListener(eventName: 'authStateChange', listenerFunc: AuthStateChangeListener) => Promise<PluginListenerHandle>
```

聆听用户的登录状态变化 .

**请注意:** 此听器不会在 `skipNativeAuth` 已使用。 取而代之的是火地JavaScript SDK.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'authStateChange'` |
| **`listenerFunc`** | `[AuthStateChangeListener](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-authstatechangelistener)` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-pluginlistenerhandle)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 添加倾听器( “ id TokenChange ” ,...)

```typescript
addListener(eventName: 'idTokenChange', listenerFunc: IdTokenChangeListener) => Promise<PluginListenerHandle>
```

听当前登录用户的 ID 令牌更改 .

**请注意:** 此听器不会在 `skipNativeAuth` 已使用。 取而代之的是火地JavaScript SDK.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'idTokenChange'` |
| **`listenerFunc`** | `[IdTokenChangeListener](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-idtokenchangelistener)` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-pluginlistenerhandle)>`

**自:** 6.3.0 (单位:千美元)

* * *

### 添加聆听器( “ 手机验证完成 ” ,...)

```typescript
addListener(eventName: 'phoneVerificationCompleted', listenerFunc: PhoneVerificationCompletedListener) => Promise<PluginListenerHandle>
```

听电话检查完毕.

这个听众只在两种情况下开火:

1.  **即时核查**: 在某些情况下,可以立即拨打电话号码 不需要发送或输入核查代码.
2.  **自动检索**: 在一些设备上,Google Play服务可以自动 检测进入的核查短消息,并在不进行核查的情况下进行核查 用户动作.

仅供Android使用.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'phoneVerificationCompleted'` |
| **`listenerFunc`** | `[PhoneVerificationCompletedListener](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-phoneverificationcompletedlistener)` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-pluginlistenerhandle)>`

**自:** 1.3.0 (单位:千美元)

* * *

### 添加倾听器( “ 电话验证失败 ” ,...)

```typescript
addListener(eventName: 'phoneVerificationFailed', listenerFunc: PhoneVerificationFailedListener) => Promise<PluginListenerHandle>
```

听电话验证失败.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'phoneVerificationFailed'` |
| **`listenerFunc`** | `[PhoneVerificationFailedListener](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-phoneverificationfailedlistener)` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-pluginlistenerhandle)>`

**自:** 1.3.0 (单位:千美元)

* * *

### 添加倾听器( “ 手机代码Sent' ,...)

```typescript
addListener(eventName: 'phoneCodeSent', listenerFunc: PhoneCodeSentListener) => Promise<PluginListenerHandle>
```

听电话验证码.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'phoneCodeSent'` |
| **`listenerFunc`** | `[PhoneCodeSentListener](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-phonecodesentlistener)` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-firebase/authentication/#readme-pluginlistenerhandle)>`

**自:** 1.3.0 (单位:千美元)

* * *

### 删除所有收听器( )

```typescript
removeAllListeners() => Promise<void>
```

删除此插件的所有听众 .

**自:** 0.1.0 (中文(简体) )

* * *

### 接口

#### 应用动作代码选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`oobCode`** | `string` | 发给用户的验证码 . | 0.2.2 (中文(简体) ) |

#### 确认 Password 重置选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`oobCode`** | `string` | 发给用户的验证码 . | 0.2.2 (中文(简体) ) |
| **`newPassword`** | `string` | 新密码. |  |

## 常见问题

### @capacitor-firebase/authentication 是什么？

在Android,iOS,和Web上用于Firebase认证的电容插件\.

### 如何安装 @capacitor-firebase/authentication？

在项目目录运行 npm install @capacitor-firebase/authentication，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capacitor-firebase/authentication 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capacitor-firebase/authentication 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capacitor-firebase/authentication 可以商用吗？

@capacitor-firebase/authentication 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @capacitor-firebase/authentication 的下载量有多少？

根据 npm 官方下载统计，@capacitor-firebase/authentication 在 2026/10/09 – 2026/11/07 这 30 天内被下载 635,517 次，日均约 21,184 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capacitor-firebase/authentication 还在维护吗？

最新版本 8\.6\.0 发布于 2026/10/31（9 天前）；至今共发布 98 个版本，其中过去 12 个月发布了 15 个；首次发布于 2022/03/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。