regras . firestore
Variáveis e métodos específicos de contexto para regras de segurança do Cloud Firestore.
As funções neste namespace estão disponíveis apenas dentro dos blocos service cloud.firestore { ... } e não precisam ser prefixadas quando usadas ( get() e não firestore.get() ).
Interfaces
Solicitar
O contexto da solicitação recebida para uma operação do Firestore.
Recurso
O documento do Firestore sendo lido ou gravado.
Propriedades
solicitar
regras não nulas.firestore.Request
O contexto da solicitação, incluindo informações de autenticação e dados pendentes.
recurso
regras não nulas.firestore.Resource
O recurso que está sendo lido ou gravado.
Métodos
existe
existe(caminho) retorna regras.Boolean
Verifique se existe um documento.
Parâmetro | |
|---|---|
caminho | O caminho. O valor não deve ser nulo. |
- Devoluções
non-null rules.Booleanverdadeiro se o recurso existir.
Exemplo
// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)existeDepois
existeAfter(caminho) retorna regras.Boolean
Verifique se existe um documento, assumindo que a solicitação atual foi bem-sucedida. Equivalente a getAfter(path) != null.
Parâmetro | |
|---|---|
caminho | O caminho. O valor não deve ser nulo. |
- Devoluções
non-null rules.Booleanverdadeiro se o recurso existir.
pegar
get(caminho) retorna regras.firestore.Resource
Obtenha o conteúdo de um documento do firestore.
Parâmetro | |
|---|---|
caminho | O caminho. O valor não deve ser nulo. |
- Devoluções
non-null rules.firestore.Resourceo documento ou nulo se ele não existir.
Exemplo
// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)obterDepois
getAfter(caminho) retorna regras.firestore.Resource
Obtenha o conteúdo projetado de um documento. O documento é retornado como se a solicitação atual tivesse sido bem-sucedida. Útil para validar documentos que fazem parte de uma gravação ou transação em lote.
Parâmetro | |
|---|---|
caminho | O caminho. O valor não deve ser nulo. |
- Devoluções
non-null rules.firestore.Resourceo documento ou nulo se ele não existir.