名前空間: Firestore

rules.firestore

namespace   静的

Cloud Firestore のコンテキスト固有の変数とメソッド 適用できます。

この Namespace の関数は、この Namespace 内でのみ service cloud.firestore { ... } 個のブロックと 使用するときに接頭辞は不要（get()） firestore.get() ではありません）。

インターフェース

プロパティ

リクエスト

静的

非 null の rules.firestore.Request

リクエスト コンテキスト（認証情報を含む） 保留中のデータを確認できます。

リソース

静的

非 null の rules.firestore.Resource

読み取りまたは書き込みの対象となるリソース。

メソッド

存在する

静的

is(path) は rules.Boolean を返します。

ドキュメントが存在するかどうかを確認します。

パラメータ

パス

rules.Path

パス。

値を null にすることはできません。
戻り値

non-null rules.Boolean: リソースが存在する場合は true。

例 

// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)

存在後

静的

isAfter(path) は rules.Boolean を返します。

現在のリクエストが成功したと想定して、ドキュメントが存在するかどうかを確認します。同等 getAfter(path) != null に変更します。

パラメータ

パス

rules.Path

パス。

値を null にすることはできません。
戻り値

non-null rules.Boolean: リソースが存在する場合は true。

get

静的

get(path) は rules.firestore.Resource を返します。

Firestore ドキュメントのコンテンツを取得します。

パラメータ

パス

rules.Path

パス。

値を null にすることはできません。
戻り値

non-null rules.firestore.Resource ドキュメント。存在しない場合は null。 あります。

例 

// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)

getAfter

静的

getAfter(path) は rules.firestore.Resource を返します。

ドキュメントの投影コンテンツを取得します。ドキュメントは次のように返されます。 成功した場合に表示されます。ドキュメントの検証に便利 バッチ書き込みまたはトランザクションの一部として 処理されています

パラメータ

パス

rules.Path

パス。

値を null にすることはできません。
戻り値

non-null rules.firestore.Resource ドキュメント。存在しない場合は null。 あります。