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 nos service cloud.firestore { ... }
e não precisam ser prefixadas quando usadas ( get()
não firestore.get()
).
Interfaces
Solicitação
O contexto de solicitação de entrada para uma operação do Firestore.
Recurso
O documento Firestore sendo lido ou escrito.
Propriedades
solicitação
regras não nulas.firestore.Request
O contexto da solicitação, incluindo informações de autenticação e dados pendentes.
recurso
non-null rules.firestore.Resource
O recurso que está sendo lido ou gravado.
Métodos
existe
existe (caminho) retorna regras. Booleano
Verifique se existe um documento.
Parâmetro | |
---|---|
caminho | O caminho. O valor não deve ser nulo. |
- Devoluções
non-null rules.Boolean
true se o recurso existir.
Exemplo
// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)
existe depois de
existeAfter (caminho) retorna regras. Booleano
Verifique se existe um documento, presumindo 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.Boolean
true se o recurso existir.
obter
get (path) retorna rules.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.Resource
o documento ou null se ele não existir.
Exemplo
// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)
getAfter
getAfter (path) retorna rules.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.Resource
o documento ou null se ele não existir.