名前空間: firestore

インターフェース

プロパティ

リクエスト

静的

null 以外のrules.firestore.Request

認証情報や保留中のデータを含むリクエスト コンテキスト。

リソース

静的

null 以外のrules.firestore.Resource

読み取りまたは書き込み中のリソース。

メソッド

存在します

静的

存在する (パス) はrules.Booleanを返します。

文書が存在するかどうかを確認します。

パラメータ

パス

ルール.パス

パス。

値は null であってはなりません。

戻り値

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

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

後に存在します

静的

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

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

パラメータ

パス

ルール.パス

パス。

値は null であってはなりません。

戻り値

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

得る

静的

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

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

パラメータ

パス

ルール.パス

パス。

値は null であってはなりません。

戻り値

non-null rules.firestore.Resourceドキュメント、またはドキュメントが存在しない場合は null。

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

取得後

静的

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

ドキュメントの投影されたコンテンツを取得します。現在のリクエストが成功したかのようにドキュメントが返されます。バッチ書き込みまたはトランザクションの一部であるドキュメントを検証する場合に役立ちます。

パラメータ

パス

ルール.パス

パス。

値は null であってはなりません。

戻り値

non-null rules.firestore.Resourceドキュメント、またはドキュメントが存在しない場合は null。