@capgo/capacitor-firebase-firestore

Vue d'ensemble

Capacitor plugin pour Firebase Cloud Firestore.

Capacités de base

• addDocument - Ajoute un nouveau document à une collection avec les données spécifiées.
• setDocument - Écrit dans le document référencé par la référence spécifiée. Si le document n'existe pas encore, il sera créé.
• getDocument - Lit le document référencé par la référence spécifiée.
• updateDocument - Met à jour les champs du document référencé par la référence spécifiée.

Public API

Méthode	Description
addDocument	Ajoute un nouveau document à une collection avec les données spécifiées.
setDocument	Écrit dans le document référencé par la référence spécifiée. Si le document n'existe pas encore, il sera créé.
getDocument	Lit le document référencé par la référence spécifiée.
updateDocument	Met à jour les champs du document référencé par la référence spécifiée.
deleteDocument	Supprime le document référencé par la référence spécifiée.
writeBatch	Exécute plusieurs opérations d'écriture en tant que lot unique.
getCollection	Lit la collection référencée par la référence spécifiée.
getCollectionGroup	Lit le groupe de collections référencé par la référence spécifiée.
getCountFromServer	Récupère le nombre de documents dans une collection.
clearPersistence	Efface le stockage persistant. Cela inclut les écritures en attente et les documents en cache.
enableNetwork	Réactive l'utilisation du réseau.
disableNetwork	Désactive l'utilisation du réseau.
useEmulator	Instrumente votre application pour communiquer avec l'émulateur Firestore.
addDocumentSnapshotListener	Ajoute un écouteur pour les événements de snapshots de documents.
addCollectionSnapshotListener	Ajoute un écouteur pour les événements de snapshots de collections.
addCollectionGroupSnapshotListener	Ajoute un écouteur pour les événements de snapshots de collections de groupe.
removeSnapshotListener	Supprime un écouteur pour les événements de snapshots de documents ou de collections.
removeAllListeners	Supprime tous les écouteurs pour ce plugin.
getPluginVersion	Obtient la version de ce plugin.

Source De Vérité

Cette référence est synchronisée à partir de src/definitions.ts dans capacitor-firebase.