跳转至正文

Firebase Firestore Capacitor 插件

适用于 Firebase Cloud Firestore 的 Capacitor 插件

安装

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

指南

如何在 Capacitor 中使用 Firebase Firestore

使用 @capgo/capacitor-firebase-firestore

适用于 Firebase Cloud Firestore 的 Capacitor 插件。

安装

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

插件暴露的内容

  • addDocument - 使用给定数据向集合添加新文档。
  • setDocument - 写入指定引用所指向的文档。如果文档尚不存在,将创建该文档。
  • getDocument - 读取指定引用所指向的文档。
  • updateDocument - 更新指定引用所指向文档中的字段。

用法示例

addDocument

向集合中添加包含给定数据的新文档。

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.addDocument({} as AddDocumentOptions);

setDocument

写入指定引用所指向的文档。如果文档尚不存在,则会创建该文档。

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.setDocument({} as SetDocumentOptions);

getDocument

读取指定引用所指向的文档。

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.getDocument({} as GetDocumentOptions);

updateDocument

更新指定引用所指向文档中的字段。

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.updateDocument({} as UpdateDocumentOptions);

完整参考

从“使用 @capgo/capacitor-firebase-firestore”继续

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

常见问题

Firebase Firestore 插件常见问题

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

运行 "bun add @capgo/capacitor-firebase-firestore"(或 "npm install @capgo/capacitor-firebase-firestore"),然后运行 "bunx cap sync",让 iOS 和 Android 项目引入原生 code。在应用 code 中从 "@capgo/capacitor-firebase-firestore" 导入。

@capgo/capacitor-firebase-firestore 支持 React、Vue 和 Angular 吗?

支持。Firebase Firestore 是一个 Capacitor 包,因此适用于任何在 Capacitor 中运行的 Web 框架,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-firebase-firestore 支持哪个 Capacitor 版本?

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

@capgo/capacitor-firebase-firestore 是免费且开源的吗?

是的。code 源代码公开在 GitHub 上,地址为 https://github.com/Cap-go/capacitor-firebase/tree/main/packages/firestore,并且可以从 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

我可以不经过 App Store 审核就更新使用 Firebase Firestore 的 code 吗?

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

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

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

开始使用 Capgo