قواعد . firestore
المتغيرات والأساليب الخاصة بالسياق لقواعد أمان Cloud Firestore.
الوظائف في مساحة الاسم هذه متاحة فقط داخل كتل service cloud.firestore { ... }
ولا تحتاج إلى أن تكون مسبوقة عند استخدامها ( get()
وليس firestore.get()
).
واجهات
طلب
سياق الطلب الوارد لعملية Firestore.
الموارد
مستند Firestore يتم قراءته أو كتابته.
ملكيات
طلب
قواعد غير فارغة.firestore.Request
سياق الطلب، بما في ذلك معلومات المصادقة والبيانات المعلقة.
الموارد
قواعد غير فارغة.firestore.Resource
المصدر الذي تتم قراءته أو كتابته.
طُرق
موجود
موجود (مسار) يُرجع القواعد.Boolean
تحقق من وجود مستند.
معامل | |
---|---|
طريق | الطريق. يجب ألا تكون القيمة فارغة. |
- عائدات
non-null rules.Boolean
صحيحة في حالة وجود المورد.
مثال
// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)
موجود بعد
موجود بعد (المسار) يُرجع القواعد.Boolean
تحقق من وجود مستند، بافتراض نجاح الطلب الحالي. أي ما يعادل getAfter(path) != null.
معامل | |
---|---|
طريق | الطريق. يجب ألا تكون القيمة فارغة. |
- عائدات
non-null rules.Boolean
صحيحة في حالة وجود المورد.
يحصل
الحصول على (المسار) يُرجع القواعد.firestore.Resource
احصل على محتويات مستند firestore.
معامل | |
---|---|
طريق | الطريق. يجب ألا تكون القيمة فارغة. |
- عائدات
non-null rules.firestore.Resource
المستند، أو فارغة إذا لم تكن موجودة.
مثال
// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)
getAfter
يُرجع getAfter(path) القواعد.firestore.Resource
احصل على المحتويات المتوقعة للمستند. يتم إرجاع المستند كما لو أن الطلب الحالي قد نجح. مفيد للتحقق من صحة المستندات التي تشكل جزءًا من عملية كتابة أو معاملة مجمعة.
معامل | |
---|---|
طريق | الطريق. يجب ألا تكون القيمة فارغة. |
- عائدات
non-null rules.firestore.Resource
المستند، أو فارغة إذا لم تكن موجودة.