@capgo/capacitor-firebase-firestore

概要

Capacitor Firebase Cloud Firestore プラグイン。

主な機能

• addDocument - 指定されたデータでコレクションに新しいドキュメントを追加します。
• setDocument - 指定された参照に記載されているドキュメントに書き込む。ドキュメントがまだ存在していない場合は、新しく作成されます。
• getDocument - 指定された参照に記載されているドキュメントを読み取ります。
• updateDocument - 指定された参照に記載されているドキュメントのフィールドを更新します。

公開 API

メソッド	説明
addDocument	指定されたデータでコレクションに新しいドキュメントを追加します。
setDocument	指定された参照に基づいてドキュメントに書き込む。ドキュメントがまだ存在しない場合、作成されます。
getDocument	指定された参照に基づいてドキュメントを読み取ります。
updateDocument	指定された参照に基づいてドキュメントのフィールドを更新します。
deleteDocument	指定された参照に基づいてドキュメントを削除します。
writeBatch	複数の書き込み操作を単一のバッチとして実行します。
getCollection	指定された参照に基づいてコレクションを読み取ります。
getCollectionGroup	指定された参照に基づいてコレクション グループを読み取ります。
getCountFromServer	コレクション内のドキュメントの数を取得します。
clearPersistence	永続ストレージをクリアします。これには、保留中の書き込みとキャッシュされたドキュメントも含まれます。
enableNetwork	ネットワークの使用を再有効にします。
disableNetwork	ネットワークの使用を無効にします。
useEmulator	アプリをインストルメントして、Firestore エミュレータと通信するようにします。
addDocumentSnapshotListener	ドキュメント スナップショット イベントのリスナーを追加します。
addCollectionSnapshotListener	コレクション スナップショット イベントのリスナーを追加します。
addCollectionGroupSnapshotListener	コレクション グループ スナップショット イベントのリスナーを追加します。
removeSnapshotListener	ドキュメントまたはコレクション スナップショット イベントのリスナーを削除します。
removeAllListeners	このプラグインのすべてのリスナーを削除します。
getPluginVersion	このプラグインのバージョンを取得します。

真実の源

このリファレンスは src/definitions.ts で capacitor-firebase.