Пространство имен: Firestore

правила . пожарная лавка

статическое пространство имен

Контекстно-зависимые переменные и методы для правил безопасности Cloud Firestore.

Функции в этом пространстве имен доступны только внутри блоков service cloud.firestore { ... } и не нуждаются в префиксе при использовании ( get() not firestore.get() ).

Интерфейсы

Запрос

Контекст входящего запроса для операции Firestore.

Ресурс

Документ Firestore читается или записывается.

Характеристики

запрос

статический

ненулевые правила.firestore.Request

Контекст запроса, включая информацию аутентификации и ожидающие данные.

ресурс

статический

ненулевые правила.firestore.Resource

Ресурс, который читается или записывается.

Методы

существует

статический

существует (путь) возвращает правила. Логическое значение

Проверьте, существует ли документ.

Параметр
путь	правила.Путь Путь. Значение не должно быть нулевым.

Возврат

non-null rules.Boolean значение true, если ресурс существует.

Пример

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

существуетПосле

статический

существуетАфтер (путь) возвращает правила. Логическое значение

Проверьте, существует ли документ, предполагая, что текущий запрос выполнен успешно. Эквивалентно getAfter(path) != null.

Параметр
путь	правила.Путь Путь. Значение не должно быть нулевым.

Возврат

non-null rules.Boolean значение true, если ресурс существует.

получать

статический

get(path) возвращает rule.firestore.Resource

Получите содержимое документа Firestore.

Параметр
путь	правила.Путь Путь. Значение не должно быть нулевым.

Возврат

non-null rules.firestore.Resource документа или значение null, если он не существует.

Пример

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

getAfter

статический

getAfter(path) возвращает Rules.firestore.Resource

Получите прогнозируемое содержимое документа. Документ возвращается так, как если бы текущий запрос был выполнен успешно. Полезно для проверки документов, которые являются частью пакетной записи или транзакции.

Параметр
путь	правила.Путь Путь. Значение не должно быть нулевым.

Возврат

non-null rules.firestore.Resource документа или значение null, если он не существует.