跳转至正文
@capgo/capacitor-firebase-app-check 身份验证与安全 开源

Firebase App Check Capacitor 插件

适用于 Firebase App Check 的 Capacitor 插件

安装

bun add @capgo/capacitor-firebase-app-check bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-firebase-app-check
  • pnpm add @capgo/capacitor-firebase-app-check
  • yarn add @capgo/capacitor-firebase-app-check

指南

如何在 Capacitor 中使用 Firebase App Check

使用 @capgo/capacitor-firebase-app-check

用于 Firebase App Check 的 Capacitor 插件

安装

bun add @capgo/capacitor-firebase-app-check
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';

API 概览

方法 描述
getToken 获取当前的 App Check token。
initialize 为指定的 App 激活 App Check。每个 App 仅能调用一次。
setTokenAutoRefreshEnabled 设置 App Check token 是否应自动刷新。

示例

getToken()

获取当前的 App Check token。

import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';

const result = await FirebaseAppCheck.getToken();
// The result holds sensitive values: use it without logging it.

initialize()

为指定的 App 激活 App Check。每个 App 仅能调用一次。

import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';

await FirebaseAppCheck.initialize();

setTokenAutoRefreshEnabled()

设置 App Check token 是否应自动刷新。

import { FirebaseAppCheck } from '@capgo/capacitor-firebase-app-check';

await FirebaseAppCheck.setTokenAutoRefreshEnabled({ enabled: true });

监听事件

addListener 会返回一个句柄。调用 handle.remove() 在屏幕卸载时,或者调用 FirebaseAppCheck.removeAllListeners() 以清除所有监听器。

完整参考文档

继续使用 @capgo/capacitor-firebase-app-check

如果你正在使用 使用 @capgo/capacitor-firebase-app-check 要规划原生插件工作,请将其与 Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节, 添加或更新插件 查看添加或更新插件中的实现细节, Ionic Enterprise 插件替代方案 查看 Ionic Enterprise 插件替代方案中的产品工作流,以及 Capgo Native Build 查看 Capgo Native Builds 中的产品工作流。

常见问题

Firebase App Check 插件常见问题

如何在 Capacitor 应用中安装 Firebase App Check 插件?

运行 "bun add @capgo/capacitor-firebase-app-check" (或 "npm install @capgo/capacitor-firebase-app-check"),然后运行 "bunx cap sync",使 iOS 和 Android 项目同步 native code。最后在你的应用 code 中从 "@capgo/capacitor-firebase-app-check" 导入即可。

@capgo/capacitor-firebase-app-check 是否支持 React、Vue 和 Angular?

是的。Firebase App Check 是一个 Capacitor package,因此它适用于任何运行在 Capacitor 中的 web framework,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-firebase-app-check 支持哪个版本的 Capacitor?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-firebase-app-check 是免费开源的吗?

是的。code 的源码已在 GitHub 上公开,地址为 https://github.com/Cap-go/capacitor-firebase/tree/main/packages/app-check,该 package 可从 npm 免费安装。欢迎提交 Bug 报告和 pull request。

使用 Firebase App Check 的 code 可以在不经过 App Store 审核的情况下更新吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待应用审核,即可快速发布 Firebase App Check 的变更

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo