rules. firestore
Variables y métodos específicos del contexto para Cloud Firestore con las reglas de seguridad.
Las funciones de este espacio de nombres solo están disponibles en
service cloud.firestore { ... }
bloquea y
no necesitan tener un prefijo cuando se usan (get()
no firestore.get()
).
Interfaces
Solicitud
El contexto de la solicitud entrante para una operación de Firestore.
Recurso
El documento de Firestore que se está leyendo o escribiendo.
Propiedades
solicitud
rules.firestore.Request no nulos
El contexto de la solicitud, incluida la información de autenticación y pendientes.
recurso
rules.firestore.Resource no nulo
El recurso que se lee o se escribe.
Métodos
existe
existe(ruta) muestra rules.Boolean
Comprueba si existe un documento.
Parámetro |
|
---|---|
ruta |
La ruta. El valor no debe ser nulo. |
- Devoluciones
-
non-null rules.Boolean
es verdadero si el recurso existe.
Ejemplo
// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)
existeDespués
existeAfter(ruta) muestra rules.Boolean
Comprueba si existe un documento, suponiendo que la solicitud actual se realiza correctamente. Equivalente a getAfter(path) != null.
Parámetro |
|
---|---|
ruta |
La ruta. El valor no debe ser nulo. |
- Devoluciones
-
non-null rules.Boolean
es verdadero si el recurso existe.
get
get(path) muestra rules.firestore.Resource.
Obtén el contenido de un documento de Firestore.
Parámetro |
|
---|---|
ruta |
La ruta. El valor no debe ser nulo. |
- Devoluciones
-
non-null rules.firestore.Resource
el documento o un valor nulo si no lo tiene existen.
Ejemplo
// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)
getAfter
getAfter(path) muestra rules.firestore.Resource.
Obtén el contenido proyectado de un documento. El documento se devuelve como si la solicitud actual se realizó correctamente. Útil para validar documentos de escritura o transacción en lotes.
Parámetro |
|
---|---|
ruta |
La ruta. El valor no debe ser nulo. |
- Devoluciones
-
non-null rules.firestore.Resource
el documento o un valor nulo si no lo tiene existen.