aturan . toko api
Kontekskan variabel dan metode tertentu untuk aturan keamanan Cloud Firestore.
Fungsi dalam namespace ini hanya tersedia di dalam blok service cloud.firestore { ... }
dan tidak perlu diawali saat digunakan ( get()
bukan firestore.get()
).
Antarmuka
Meminta
Konteks permintaan masuk untuk operasi Firestore.
Sumber
Dokumen Firestore sedang dibaca atau ditulis.
Properti
meminta
aturan non-null.firestore.Request
Konteks permintaan, termasuk informasi autentikasi dan data yang tertunda.
sumber
aturan non-null.firestore.Resource
Sumber daya sedang dibaca atau ditulis.
Metode
ada
ada(jalur) mengembalikan aturan.Boolean
Periksa apakah ada dokumen.
Parameter | |
---|---|
jalur | Jalan. Nilai tidak boleh nol. |
- Kembali
non-null rules.Boolean
benar jika sumber daya ada.
Contoh
// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)
adaSetelah
adaSetelah(jalur) mengembalikan aturan.Boolean
Periksa apakah ada dokumen, dengan asumsi permintaan saat ini berhasil. Setara dengan getAfter(path) != null.
Parameter | |
---|---|
jalur | Jalan. Nilai tidak boleh nol. |
- Kembali
non-null rules.Boolean
benar jika sumber daya ada.
mendapatkan
get(path) mengembalikan aturan.firestore.Resource
Dapatkan konten dokumen firestore.
Parameter | |
---|---|
jalur | Jalan. Nilai tidak boleh nol. |
- Kembali
non-null rules.firestore.Resource
dokumen, atau null jika tidak ada.
Contoh
// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)
dapatkan Setelahnya
getAfter(path) mengembalikan aturan.firestore.Resource
Dapatkan isi dokumen yang diproyeksikan. Dokumen dikembalikan seolah-olah permintaan saat ini berhasil. Berguna untuk memvalidasi dokumen yang merupakan bagian dari penulisan atau transaksi batch.
Parameter | |
---|---|
jalur | Jalan. Nilai tidak boleh nol. |
- Kembali
non-null rules.firestore.Resource
dokumen, atau null jika tidak ada.