מרחב שמות: firestore

כללים . firestore

מרחב שמות סטטי

משתנים ושיטות ספציפיים להקשר עבור כללי אבטחה של Cloud Firestore.

פונקציות במרחב השמות הזה זמינות רק בתוך בלוקים service cloud.firestore { ... } ואין צורך לקבל קידומת כאשר משתמשים בהם ( get() לא firestore.get() ).

ממשקים

בַּקָשָׁה

הקשר הבקשה הנכנסת עבור פעולת Firestore.

מַשׁאָב

מסמך Firestore הנקרא או כתוב.

נכסים

בַּקָשָׁה

סטָטִי

non-null rules.firestore.Request

הקשר הבקשה, כולל מידע אימות ונתונים ממתינים.

מַשׁאָב

סטָטִי

non-null rules.firestore.Resource

המשאב הנקרא או הכתוב.

שיטות

קיים

סטָטִי

exists(path) מחזיר חוקים.בוליאן

בדוק אם קיים מסמך.

פָּרָמֶטֶר
נָתִיב	כללים.נתיב הנתיב. הערך לא יכול להיות ריק.

החזרות

non-null rules.Boolean true אם המשאב קיים.

דוגמא

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

קיים לאחר

סטָטִי

existsAfter(נתיב) מחזיר חוקים.בוליאן

בדוק אם קיים מסמך, בהנחה שהבקשה הנוכחית מצליחה. שווה ערך ל-getAfter(path) != null.

פָּרָמֶטֶר
נָתִיב	כללים.נתיב הנתיב. הערך לא יכול להיות ריק.

החזרות

non-null rules.Boolean true אם המשאב קיים.

לקבל

סטָטִי

get(path) מחזיר את rules.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(נתיב) מחזירה rules.firestore.Resource

קבל את התוכן המוקרן של מסמך. המסמך מוחזר כאילו הבקשה הנוכחית הצליחה. שימושי לאימות מסמכים שהם חלק מכתיבה או עסקה אצווה.

פָּרָמֶטֶר
נָתִיב	כללים.נתיב הנתיב. הערך לא יכול להיות ריק.

החזרות

non-null rules.firestore.Resource המסמך, או null אם הוא לא קיים.