@capgo/capacitor-firebase-firestore

概览

适用于 Firebase Cloud Firestore 的 Capacitor 插件

从 addDocument() 以及下方列出的其他核心方法。

平台支持

平台	支持	备注
iOS	是	原生
Android	是	原生
Web 端	否	使用 Capacitor.getPlatform() 做保护

核心功能

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

公开 API

方法	描述
addDocument	向集合中添加包含给定数据的新文档。
setDocument	写入指定引用所指向的文档。如果文档尚不存在，则会创建该文档。
getDocument	读取指定引用所指向的文档。
updateDocument	更新指定引用所指向文档中的字段。
deleteDocument	删除指定引用所指向的文档。
writeBatch	将多个写入操作作为单个批次执行。
getCollection	读取指定引用所指向的集合。
getCollectionGroup	读取指定引用所指向的集合组。
getCountFromServer	获取集合中的文档数量。
clearPersistence	清除持久化存储。包括待处理的写入和缓存的文档。
enableNetwork	重新启用网络使用。
disableNetwork	禁用网络使用。
useEmulator	将你的 App 配置为与 Firestore emulator 通信。
addDocumentSnapshotListener	为文档快照事件添加监听器。
addCollectionSnapshotListener	为集合快照事件添加监听器。
addCollectionGroupSnapshotListener	为集合组快照事件添加监听器。
removeSnapshotListener	移除文档或集合快照事件的监听器。
removeAllListeners	移除该插件的所有监听器。
getPluginVersion	获取此插件的版本。

单一事实来源

此参考文档同步自 src/definitions.ts 中的 capacitor-firebase.

继续了解 @capgo/capacitor-firebase-firestore

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