Namespace: firestore

rules.firestore

namespace   estático

Variáveis e métodos específicos do contexto para o Cloud Firestore regras de segurança.

As funções nesse namespace só estão disponíveis dentro service cloud.firestore { ... } blocos e não precisam ser prefixados quando usados (get() e não firestore.get()).

Interfaces

Solicitação

O contexto da solicitação recebida para uma operação do Firestore.

Recurso

O documento do Firestore que está sendo lido ou gravado.

Propriedades

solicitar

estática

rules.firestore.Request não nulos

O contexto da solicitação, incluindo informações de autenticação e dados pendentes.

recurso

estática

rules.firestore.Resource não nulo

O recurso que está sendo lido ou gravado.

Métodos

existe

estática

existe(path) retorna rules.Boolean.

Verifique se um documento existe.

Parâmetro
path	rules.Path (link em inglês) O caminho. O valor não pode ser nulo.

Retorna

non-null rules.Boolean verdadeiro se o recurso existir.

Exemplo

// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)

existeDepois

estática

existeAfter(path) retorna rules.Boolean.

Verifica se um documento existe, supondo que a solicitação atual seja bem-sucedida. Equivalente para getAfter(path) != nulo.

Parâmetro
path	rules.Path (link em inglês) O caminho. O valor não pode ser nulo.

Retorna

non-null rules.Boolean verdadeiro se o recurso existir.

get

estática

get(path) retorna rules.firestore.Resource.

Acesse o conteúdo de um documento do Firestore.

Parâmetro
path	rules.Path (link em inglês) O caminho. O valor não pode ser nulo.

Retorna

non-null rules.firestore.Resource o documento ou nulo se ele não tiver existem.

Exemplo

// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)

getAfter

estática

getAfter(path) retorna rules.firestore.Resource.

Acessar o conteúdo projetado de um documento. O documento é retornado como se a solicitação atual foi bem-sucedida. Útil para validar documentos que fazem parte de uma transação ou gravação em lote.

Parâmetro
path	rules.Path (link em inglês) O caminho. O valor não pode ser nulo.

Retorna

non-null rules.firestore.Resource o documento ou nulo se ele não tiver existem.