zasady . sklep z ogniem
Zmienne i metody specyficzne dla kontekstu dla reguł bezpieczeństwa Cloud Firestore.
Funkcje w tej przestrzeni nazw są dostępne tylko w blokach service cloud.firestore { ... } i nie muszą być poprzedzane, gdy są używane ( get() nie firestore.get() ).
Interfejsy
Wniosek
Kontekst żądania przychodzącego dla operacji Firestore.
Ratunek
Odczytywany lub zapisywany dokument Firestore.
Nieruchomości
wniosek
reguły inne niż null.firestore.Request
Kontekst żądania, w tym informacje uwierzytelniające i oczekujące dane.
ratunek
reguły inne niż null.firestore.Resource
Zasób, który jest odczytywany lub zapisywany.
Metody
istnieje
istnieje(ścieżka) zwraca reguły. Wartość logiczna
Sprawdź, czy dokument istnieje.
Parametr | |
|---|---|
ścieżka | Ścieżka. Wartość nie może mieć wartości null. |
- Zwroty
non-null rules.Booleantrue, jeśli zasób istnieje.
Przykład
// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)istniejePo
istniejeAfter(ścieżka) zwraca reguły.Boolean
Sprawdź, czy dokument istnieje, zakładając, że bieżące żądanie powiedzie się. Odpowiednik getAfter(ścieżka) != null.
Parametr | |
|---|---|
ścieżka | Ścieżka. Wartość nie może mieć wartości null. |
- Zwroty
non-null rules.Booleantrue, jeśli zasób istnieje.
Dostawać
get(path) zwraca reguły.firestore.Resource
Pobierz zawartość dokumentu Firestore.
Parametr | |
|---|---|
ścieżka | Ścieżka. Wartość nie może mieć wartości null. |
- Zwroty
non-null rules.firestore.Resourcedokumentu lub wartość null, jeśli nie istnieje.
Przykład
// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)getAfter
getAfter(ścieżka) zwraca reguły.firestore.Resource
Uzyskaj rzutowaną zawartość dokumentu. Dokument jest zwracany tak, jakby bieżące żądanie zakończyło się sukcesem. Przydatne do sprawdzania dokumentów będących częścią zbiorczego zapisu lub transakcji.
Parametr | |
|---|---|
ścieżka | Ścieżka. Wartość nie może mieć wartości null. |
- Zwroty
non-null rules.firestore.Resourcedokumentu lub wartość null, jeśli nie istnieje.