@capgo/capacitor-firebase-firestore

Übersicht

Capacitor Plugin für Firebase Cloud Firestore.

Hauptfunktionen

• addDocument - Fügt einem Sammlung einen neuen Dokument mit den angegebenen Daten hinzu.
• setDocument - Schreibt in das Dokument, das durch die angegebene Referenz bezeichnet wird. Wenn das Dokument noch nicht existiert, wird es erstellt.
• getDocument - Liest das Dokument, das durch die angegebene Referenz bezeichnet wird.
• updateDocument - Aktualisiert Felder im Dokument, das durch die angegebene Referenz bezeichnet wird.

Öffentlich API

Methode	Beschreibung
addDocument	Fügt einem Sammlung einen neuen Dokument mit den angegebenen Daten hinzu.
setDocument	Schreibt in das Dokument, das durch die angegebene Referenz bezeichnet wird. Wenn das Dokument noch nicht existiert, wird es erstellt.
getDocument	Schreibt in das Dokument, das durch die angegebene Referenz bezeichnet wird. Wenn das Dokument noch nicht existiert, wird es erstellt.
updateDocument	Liest das Dokument, das durch die angegebene Referenz bezeichnet wird.
deleteDocument	Aktualisiert die Felder im Dokument, das durch die angegebene Referenz bezeichnet wird.
writeBatch	Löscht das Dokument, das durch die angegebene Referenz bezeichnet wird.
getCollection	Führt mehrere Schreiboperationen als einzelnen Batch aus.
getCollectionGroup	Liest die Sammlung, die durch die angegebene Referenz bezeichnet wird.
getCountFromServer	Liest die Anzahl der Dokumente in einer Sammlung.
clearPersistence	Löscht die persistenten Speicher. Dies umfasst schreibende Vorgänge und gecachte Dokumente.
enableNetwork	Aktiviert die Nutzung des Netzwerks.
disableNetwork	Deaktiviert die Nutzung des Netzwerks.
useEmulator	Instrumentiert Ihre App, um mit dem Firestore-Emulator zu kommunizieren.
addDocumentSnapshotListener	Fügt einen Listener für Dokument-Snapshot-Ereignisse hinzu.
addCollectionSnapshotListener	Fügt einen Listener für Sammlung-Snapshot-Ereignisse hinzu.
addCollectionGroupSnapshotListener	Fügt einen Listener für Sammlungsgruppen-Snapshot-Ereignisse hinzu.
removeSnapshotListener	Entfernt einen Listener für Dokument- oder Sammlung-Snapshot-Ereignisse.
removeAllListeners	Entfernt alle Listener für diesen Plugin.
getPluginVersion	Ermittelt die Version dieses Plugins.

Quelle der Wahrheit

Diese Referenz wird von src/definitions.ts in capacitor-firebase.