reglas . fuego
Variables y métodos específicos del contexto para las reglas de seguridad de Cloud Firestore.
Las funciones en este espacio de nombres solo están disponibles dentro de service cloud.firestore { ... }
y no es necesario que tengan el prefijo cuando se usan ( get()
no firestore.get()
).
Interfaces
Pedido
El contexto de solicitud entrante para una operación de Firestore.
Recurso
Se está leyendo o escribiendo el documento de Firestore.
Propiedades
pedido
reglas no nulas.firestore.Request
El contexto de la solicitud, incluida la información de autenticación y los datos pendientes.
recurso
reglas no nulas.firestore.Resource
El recurso que se está leyendo o escribiendo.
Métodos
existe
existe (ruta) devuelve reglas.
Compruebe si existe un documento.
Parámetro | |
---|---|
camino | El camino. El valor no debe ser nulo. |
- Devoluciones
non-null rules.Boolean
verdadero si el recurso existe.
Ejemplo
// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)
existe después
existeDespués (ruta) devuelve reglas.
Compruebe si existe un documento, asumiendo que la solicitud actual se realiza correctamente. Equivalente a getAfter (ruta)! = Null.
Parámetro | |
---|---|
camino | El camino. El valor no debe ser nulo. |
- Devoluciones
non-null rules.Boolean
verdadero si el recurso existe.
obtener
get (ruta) devuelve rules.firestore.Resource
Obtenga el contenido de un documento de Firestore.
Parámetro | |
---|---|
camino | El camino. El valor no debe ser nulo. |
- Devoluciones
non-null rules.firestore.Resource
el documento, o nulo si no existe.
Ejemplo
// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)
ir detras
getAfter (ruta) devuelve rules.firestore.Resource
Obtenga el contenido proyectado de un documento. El documento se devuelve como si la solicitud actual se hubiera realizado correctamente. Útil para validar documentos que forman parte de una transacción o escritura por lotes.
Parámetro | |
---|---|
camino | El camino. El valor no debe ser nulo. |
- Devoluciones
non-null rules.firestore.Resource
el documento, o nulo si no existe.