跳过内容
Capgo - 实时更新 Capacitor 应用程序 Capgo

Getting Started

GitHub

安装

标题为“安装”的部分

您可以使用我们的AI辅助设置来安装插件。使用以下命令将Capgo技能添加到您的AI工具中：

终端窗口
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-firestore` plugin in my project.

如果您更喜欢手动设置，请通过运行以下命令安装插件并按照以下平台特定的说明进行操作：

终端窗口
bun add @capgo/capacitor-firebase-firestore
bunx cap sync

导入

标题为“导入”的部分
import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

API概述

标题为“API概述”的部分

addDocument

标题为“addDocument”

添加一个新的文档到一个集合中，使用给定的数据。

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


await FirebaseFirestore.addDocument({} as AddDocumentOptions);

setDocument

标题：setDocument

将数据写入指定的文档引用。 如果文档尚未存在，则会创建一个新的文档。

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


await FirebaseFirestore.setDocument({} as SetDocumentOptions);

getDocument

标题：getDocument

读取指定的文档引用。

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


await FirebaseFirestore.getDocument({} as GetDocumentOptions);

updateDocument

标题：updateDocument

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

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


await FirebaseFirestore.updateDocument({} as UpdateDocumentOptions);

deleteDocument

标题：deleteDocument

删除指定引用指向的文档。

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


await FirebaseFirestore.deleteDocument({} as DeleteDocumentOptions);

writeBatch

写批次

以单个批次形式执行多个写操作。

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


await FirebaseFirestore.writeBatch({} as WriteBatchOptions);

getCollection

获取集合

读取指定引用指向的集合。

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


await FirebaseFirestore.getCollection({} as GetCollectionOptions);

getCollectionGroup

获取集合组

读取指定引用指向的集合组。

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


await FirebaseFirestore.getCollectionGroup({} as GetCollectionGroupOptions);

getCountFromServer

获取计数

获取集合中的文档数量。

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


await FirebaseFirestore.getCountFromServer({} as GetCountFromServerOptions);

clearPersistence

清除持久性

清除持久存储。包括待写入的内容和缓存的文档。

在应用程序关闭或首次启动后必须调用。

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


await FirebaseFirestore.clearPersistence();

enableNetwork

启用网络

重新启用网络使用。

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


await FirebaseFirestore.enableNetwork();

disableNetwork

禁用网络

禁用网络使用。

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


await FirebaseFirestore.disableNetwork();

useEmulator

使用模拟器

为应用程序配置模拟 Firestore 的通信方式。

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


await FirebaseFirestore.useEmulator({} as UseEmulatorOptions);

addDocumentSnapshotListener

添加文档快照监听器

为文档快照事件添加监听器。

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


await FirebaseFirestore.addDocumentSnapshotListener({} as AddDocumentSnapshotListenerOptions, {} as AddDocumentSnapshotListenerCallback<T>);

addCollectionSnapshotListener

添加集合快照监听器

为集合快照事件添加监听器。

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


await FirebaseFirestore.addCollectionSnapshotListener({} as AddCollectionSnapshotListenerOptions, {} as AddCollectionSnapshotListenerCallback<T>);

addCollectionGroupSnapshotListener

添加集合组快照监听器

为集合组快照事件添加监听器。

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


await FirebaseFirestore.addCollectionGroupSnapshotListener({} as AddCollectionGroupSnapshotListenerOptions, {} as AddCollectionGroupSnapshotListenerCallback<T>);

removeSnapshotListener

《removeSnapshotListener》

移除文档或集合快照事件的监听器

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


await FirebaseFirestore.removeSnapshotListener({} as RemoveSnapshotListenerOptions);

类型参考

《类型参考》

AddDocumentOptions

《AddDocumentOptions》
export interface AddDocumentOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   * @example 'users'
   */
  reference: string;
  /**
   * An object containing the data for the new document.
   *
   * @since 5.2.0
   * @example { first: 'Alan', last: 'Turing', born: 1912 }
   */
  data: DocumentData;
}

AddDocumentResult

《AddDocumentResult》
export interface AddDocumentResult {
  /**
   * The reference of the newly added document.
   *
   * @since 5.2.0
   */
  reference: DocumentReference;
}

SetDocumentOptions

《SetDocumentOptions》
export interface SetDocumentOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   * @example 'users/Aorq09lkt1ynbR7xhTUx'
   */
  reference: string;
  /**
   * An object containing the data for the new document.
   *
   * @since 5.2.0
   * @example { first: 'Alan', last: 'Turing', born: 1912 }
   */
  data: DocumentData;
  /**
   * Whether to merge the provided data with an existing document.
   *
   * @since 5.2.0
   * @example true
   * @default false
   */
  merge?: boolean;
}

DocumentData

《DocumentData》
export interface DocumentData {
  /**
   * A mapping between a field and its value.
   *
   * @since 5.2.0
   */
  [field: string]: any;
}

GetDocumentOptions

标题：获取文档选项
export interface GetDocumentOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   */
  reference: string;
}

GetDocumentResult

标题：获取文档结果
export interface GetDocumentResult<T> {
  /**
   * The current document contents.
   *
   * @since 5.2.0
   */
  snapshot: DocumentSnapshot<T>;
}

UpdateDocumentOptions

标题：更新文档选项
export interface UpdateDocumentOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   */
  reference: string;
  /**
   * An object containing the data for the new document.
   *
   * @since 5.2.0
   * @example { first: 'Alan', last: 'Turing', born: 1912 }
   */
  data: DocumentData;
}

DeleteDocumentOptions

标题：删除文档选项
export interface DeleteDocumentOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   */
  reference: string;
}

WriteBatchOptions

标题：批量写入选项
export interface WriteBatchOptions {
  /**
   * The operations to execute in the batch.
   *
   * @since 6.1.0
   */
  operations: WriteBatchOperation[];
}

GetCollectionOptions

标题：获取集合选项
export interface GetCollectionOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   */
  reference: string;
  /**
   * The filter to apply.
   *
   * @since 5.2.0
   */
  compositeFilter?: QueryCompositeFilterConstraint;
  /**
   * Narrow or order the set of documents to retrieve, but do not explicitly filter for document fields.
   *
   * @since 5.2.0
   */
  queryConstraints?: QueryNonFilterConstraint[];
}

GetCollectionResult

标题：获取集合结果
export interface GetCollectionResult<T> {
  /**
   * The documents in the collection.
   *
   * @since 5.2.0
   */
  snapshots: DocumentSnapshot<T>[];
}

GetCollectionGroupOptions

标题：获取集合组选项
export interface GetCollectionGroupOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   */
  reference: string;
  /**
   * The filter to apply.
   *
   * @since 5.2.0
   */
  compositeFilter?: QueryCompositeFilterConstraint;
  /**
   * Narrow or order the set of documents to retrieve, but do not explicitly filter for document fields.
   *
   * @since 5.2.0
   */
  queryConstraints?: QueryNonFilterConstraint[];
}

真实数据来源

标题：真实数据来源

本页面由插件生成 src/definitions.ts. 当公共 API 在上游发生变化时，请重新同步

继续从开始

标题：继续从开始

如果您正在使用 开始使用 为API的仪表板和操作规划,连接它到 API概览 在API概览中了解实现细节, 介绍 在介绍中了解实现细节, API密钥 在API密钥中了解实现细节, 设备 在设备中了解实现细节,和 捆绑包 在捆绑包中了解实现细节,.