[]
【重要】2024年1月公開のアップデート「未適用」のお客様へ デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Wijmo_Cloud.Firestore

Firestore クラス

1つ以上のコレクションを含むFirestoreデータベースを表します。

各コレクションは、コレクション上のデータを CollectionView オブジェクトとして公開する Collection オブジェクトによって表されます。 このオブジェクトは、任意のWijmoコントロールのデータソースとして使用できます。

完全なCRUDサポートに加えて、ソート、フィルタ処理、ページング、グループ化などの CollectionView 機能を使用できます。 ソート、フィルタリング、およびページングは、Collection.sortOnServer、 Collection.filterOnServer、および Collection.pageOnServer プロパティの設定に応じて、 サーバーまたはクライアントで実行できます。

以下のコードは、3つのコレクションからデータを読み込む Firestore オブジェクトをインスタンス化する方法を示しています。

import { Firestore } from '@grapecity/wijmo.cloud';
const PROJECT_ID = 'XXXX-YYYY';
const API_KEY = 'ZZZZ';
let fsNWind = new Firestore(PROJECT_ID, API_KEY, {
    collections: [ 'Products', 'Categories', 'Suppliers' ]
});

このクラスは、Firestoreクライアントライブラリを使用しません。

階層

  • Firestore

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

  • new Firestore(projectId: string, apiKey: string, options?: any): Firestore

  • Firestoreクラスの新しいインスタンスを初期化します。

    引数

    • projectId: string

      データベースを含むFirebaseアプリケーションのID。

    • apiKey: string

      アプリケーションに関連付けられた要求を認証するために使用される一意の識別子。 APIキーを生成するには、「https://console.cloud.google.com/」を参考してください。

    • オプション options: any

      この Firestore の初期化データ（プロパティ値とイベントハンドラ）を含むJavaScriptオブジェクト。

    戻り値 Firestore

プロパティ

accessToken

accessToken: string | null

データベースへのアクセスに使用されるOAuth 2.0アクセストークンを取得または設定します。

OAuth2クラスでは、ユーザーにログインを許可し、accessToken文字列を取得できます。

この認証方法を選択した場合、Firestoreセキュリティの規則が適用されません。 Firestoreは代わりにCloud Identity and Access Management（IAM）を使用します。

詳細については、Firestoreセキュリティの規則と統合する idToken プロパティも参考してください。

apiKey

apiKey: string

このFirestoreの作成に使用されるAPIキーを取得します。

collections

collections: ObservableArray<Collection>

この Firestore の Collection オブジェクトのリストを取得します。

idToken

idToken: string | null

データベースへのアクセスに使用されるOAuth 2.0 IDトークンを取得または設定します。

OAuth2 クラスを使用して、ユーザーがログインし、idToken 文字列を取得できます。

この認証方法を選択する場合、通常どおりFirestoreセキュリティの規則が適用され、データベースに対して読み取りと書き込みができるユーザーが決定されます。

accessTokenプロパティも参照してください。このプロパティは、Firestoreセキュリティの規則をバイパスし、代わりにCloud Identity and Access Management（IAM）を使用します。

projectId

projectId: string

データベースを含むFirebaseアプリケーションのIDを取得します。

メソッド

getCollection

onAccessTokenChanged

イベント

accessTokenChanged

accessTokenChanged: Event<Firestore, EventArgs>

accessToken プロパティの値が変更されたときに発生します。