@capgo/capacitor-firebase-firestore

Overview

Capacitor plugin for Firebase Cloud Firestore.

Core Capabilities

• addDocument - Adds a new document to a collection with the given data.
• setDocument - Writes to the document referred to by the specified reference. If the document does not yet exist, it will be created.
• getDocument - Reads the document referred to by the specified reference.
• updateDocument - Updates fields in the document referred to by the specified reference.

Public API

Method	Description
addDocument	Adds a new document to a collection with the given data.
setDocument	Writes to the document referred to by the specified reference. If the document does not yet exist, it will be created.
getDocument	Reads the document referred to by the specified reference.
updateDocument	Updates fields in the document referred to by the specified reference.
deleteDocument	Deletes the document referred to by the specified reference.
writeBatch	Execute multiple write operations as a single batch.
getCollection	Reads the collection referenced by the specified reference.
getCollectionGroup	Reads the collection group referenced by the specified reference.
getCountFromServer	Fetches the number of documents in a collection.
clearPersistence	Clears the persistent storage. This includes pending writes and cached documents.
enableNetwork	Re-enables use of the network.
disableNetwork	Disables use of the network.
useEmulator	Instrument your app to talk to the Firestore emulator.
addDocumentSnapshotListener	Adds a listener for document snapshot events.
addCollectionSnapshotListener	Adds a listener for collection snapshot events.
addCollectionGroupSnapshotListener	Adds a listener for collection group snapshot events.
removeSnapshotListener	Remove a listener for document or collection snapshot events.
removeAllListeners	Remove all listeners for this plugin.
getPluginVersion	Get the version of this plugin.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-firebase.