règles . magasin de feu
Variables et méthodes spécifiques au contexte pour les règles de sécurité Cloud Firestore.
Les fonctions de cet espace de noms ne sont disponibles que dans les blocs service cloud.firestore { ... } et n'ont pas besoin d'être préfixées lorsqu'elles sont utilisées ( get() et non firestore.get() ).
Interfaces
Demande
Le contexte de la demande entrante pour une opération Firestore.
Ressource
Le document Firestore en cours de lecture ou d'écriture.
Propriétés
demande
règles non nulles.firestore.Request
Le contexte de la demande, y compris les informations d'authentification et les données en attente.
Ressource
règles non nulles.firestore.Resource
La ressource en cours de lecture ou d'écriture.
Méthodes
existe
existe (chemin) renvoie des règles.Booléen
Vérifiez si un document existe.
Paramètre | |
|---|---|
chemin | Le chemin. La valeur ne doit pas être nulle. |
- Retour
non-null rules.Booleantrue si la ressource existe.
Exemple
// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)existeAprès
existeAfter(path) renvoie des règles.Boolean
Vérifiez si un document existe, en supposant que la demande actuelle réussisse. Équivalent à getAfter(path) != null.
Paramètre | |
|---|---|
chemin | Le chemin. La valeur ne doit pas être nulle. |
- Retour
non-null rules.Booleantrue si la ressource existe.
obtenir
get(path) renvoie Rules.firestore.Resource
Obtenez le contenu d'un document Firestore.
Paramètre | |
|---|---|
chemin | Le chemin. La valeur ne doit pas être nulle. |
- Retour
non-null rules.firestore.Resourcele document, ou null s'il n'existe pas.
Exemple
// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)obtenirAprès
getAfter(path) renvoie Rules.firestore.Resource
Obtenez le contenu projeté d’un document. Le document est renvoyé comme si la requête en cours avait abouti. Utile pour valider des documents faisant partie d'une écriture ou d'une transaction par lots.
Paramètre | |
|---|---|
chemin | Le chemin. La valeur ne doit pas être nulle. |
- Retour
non-null rules.firestore.Resourcele document, ou null s'il n'existe pas.