Przestrzeń nazw: Firestore

reguły.firestore

przestrzeń nazw   statyczna

Zmienne i metody zależne od kontekstu w Cloud Firestore reguł bezpieczeństwa.

Funkcje w tej przestrzeni nazw są dostępne tylko w service cloud.firestore { ... } bloków i nie muszą mieć prefiksu, gdy są używane (get() nie firestore.get()).

Interfejsy

Wyślij prośbę

Kontekst żądania przychodzącego operacji Firestore.

Zasób

Dokument Firestore odczytywany lub zapisywany.

Właściwości

żądanie

statyczny

niepusta wartość rules.firestore.Request

kontekst żądania, w tym informacje uwierzytelniające; i danych oczekujących.

zasób

statyczny

niepusta wartość rules.firestore.Resource

odczytywany lub zapisywany zasób,

Metody

istnieje

statyczny

istnieje(ścieżka) zwraca wartość rules.Boolean.

Sprawdź, czy dokument istnieje.

Parametr
ścieżka	rules.Path Ścieżka. Wartość nie może być pusta.

Zwraca

non-null rules.Boolean prawda, jeśli zasób istnieje.

Przykład

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

istniejePo

statyczny

thereAfter(path) zwraca wartość rules.Boolean.

Sprawdź, czy dokument istnieje, zakładając, że bieżące żądanie zostanie zrealizowane. Odpowiednik do getAfter(ścieżka) != null.

Parametr
ścieżka	rules.Path Ścieżka. Wartość nie może być pusta.

Zwraca

non-null rules.Boolean prawda, jeśli zasób istnieje.

get

statyczny

get(path) zwraca rules.firestore.Resource

Pobierz zawartość dokumentu Firestore.

Parametr
ścieżka	rules.Path Ścieżka. Wartość nie może być pusta.

Zwraca

non-null rules.firestore.Resource dokument lub wartość null, jeśli nie jest istnieje.

Przykład

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

getAfter

statyczny

getAfter(path) zwraca rules.firestore.Resource

Pobieranie przewidywanej zawartości dokumentu. Dokument jest zwracany jako czy bieżące żądanie zostało zrealizowane. Przydatne do weryfikacji dokumentów które są częścią zapisu lub transakcji wsadowego.

Parametr
ścieżka	rules.Path Ścieżka. Wartość nie może być pusta.

Zwraca

non-null rules.firestore.Resource dokument lub wartość null, jeśli nie jest istnieje.