Skip to content

@capgo/capacitor-firebase-firestore

Capacitor用のFirebase Cloud Firestoreプラグイン。

Capacitor用のFirebase Cloud Firestoreプラグイン。

基本機能

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

Public API

Public 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.

から@capgo/capacitor-firebase-firestoreを続けます。

「@capgo/capacitor-firebase-firestoreから続けます」セクション

Capgoを使用している場合 @capgo/capacitor-firebase-firestore native プラグインの作業を計画するには、 Capgo プラグイン ディレクトリ Capgo プラグイン ディレクトリの製品ワークフローについて Capacitor プラグイン ( Capgo によって提供 ) Capacitor プラグイン ( Capgo によって提供 ) の実装詳細について プラグインの追加または更新 プラグインの追加または更新の実装詳細について Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフローについて Capgo ネイティブ ビルド Capgo ネイティブ ビルドの製品ワークフローについて