رابط سرویس Firebase SecurityRules
.
امضا:
export declare class SecurityRules
خواص
ویژگی | اصلاح کننده ها | تایپ کنید | شرح |
---|---|---|---|
برنامه | برنامه |
مواد و روش ها
روش | اصلاح کننده ها | شرح |
---|---|---|
createRuleset (فایل) | یک مجموعه قوانین جدید از RulesFile داده شده ایجاد می کند . | |
createRulesFileFromSource (نام، منبع) | یک RulesFile با نام و منبع داده شده ایجاد می کند. اگر هر یک از آرگومان ها نامعتبر باشد، خطا می دهد. این یک عملیات محلی است و شامل هیچ تماس API شبکه نمی شود. | |
حذف Ruleset (نام) | مجموعه قوانین مشخص شده با نام داده شده را حذف می کند. نام ورودی باید رشته نام کوتاه بدون پیشوند ID پروژه باشد. به عنوان مثال، برای حذف projects/project-id/rulesets/my-ruleset ، نام کوتاه "my-ruleset" را وارد کنید. اگر Ruleset مشخص شده پیدا نشود، با خطای not-found رد می کند. | |
getFirestoreRuleset() | مجموعه قوانین را در حال حاضر در Cloud Firestore اعمال می کند. اگر هیچ مجموعه قوانینی در Firestore اعمال نشود، با یک خطای not-found رد می کند. | |
getRuleset (نام) | مجموعه قوانین را با نام مشخص شده مشخص می کند. نام ورودی باید رشته نام کوتاه بدون پیشوند ID پروژه باشد. به عنوان مثال، برای بازیابی projects/project-id/rulesets/my-ruleset ، نام کوتاه "my-ruleset" را وارد کنید. اگر Ruleset مشخص شده پیدا نشود، با خطای not-found رد می کند. | |
getStorageRuleset (سطل) | مجموعه قوانین را در حال حاضر در یک سطل فضای ذخیرهسازی ابری اعمال میکند. اگر مجموعه قوانینی روی سطل اعمال نشود، با یک خطای not-found رد می کند. | |
listRulesetMetadata (PageSize، nextPageToken) | صفحه ای از ابرداده های مجموعه قوانین را بازیابی می کند. | |
releaseFirestoreRuleset(Ruleset) | مجموعه قوانین Ruleset مشخص شده را در Cloud Firestore اعمال می کند. | |
releaseFirestoreRulesetFromSource(منبع) | یک Ruleset جدید از منبع داده شده ایجاد می کند و آن را در Cloud Firestore اعمال می کند. | |
releaseStorageRuleset (قوانین، سطل) | مجموعه قواعد تعیین شده را در یک سطل ذخیره سازی ابری اعمال می کند. | |
releaseStorageRulesetFromSource (منبع، سطل) | یک Ruleset جدید از منبع داده شده ایجاد می کند و آن را در یک سطل ذخیره سازی ابری اعمال می کند. |
SecurityRules.app
امضا:
readonly app: App;
SecurityRules.createRuleset()
یک مجموعه قوانین جدید از RulesFile داده شده ایجاد می کند .
امضا:
createRuleset(file: RulesFile): Promise<Ruleset>;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
فایل | RulesFile | فایل قوانین برای گنجاندن در Ruleset جدید. |
برمی گرداند:
Promise< مجموعه قوانین >
وعده ای که با Ruleset
جدید ایجاد شده محقق می شود .
SecurityRules.createRulesFileFromSource()
یک RulesFile با نام و منبع داده شده ایجاد می کند. اگر هر یک از آرگومان ها نامعتبر باشد، خطا می دهد. این یک عملیات محلی است و شامل هیچ تماس API شبکه نمی شود.
امضا:
createRulesFileFromSource(name: string, source: string | Buffer): RulesFile;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
نام | رشته | نامی که باید به فایل قوانین اختصاص دهید. این معمولاً یک نام فایل کوتاه است که به شناسایی فایل در مجموعه قوانین کمک می کند. |
منبع | رشته | بافر | محتویات فایل قوانین. |
برمی گرداند:
نمونه فایل قوانین جدید.
مثال
const source = '// Some rules source';
const rulesFile = admin.securityRules().createRulesFileFromSource(
'firestore.rules', source);
SecurityRules.deleteRuleset()
مجموعه قوانین مشخص شده با نام داده شده را حذف می کند. نام ورودی باید رشته نام کوتاه بدون پیشوند ID پروژه باشد. به عنوان مثال، برای حذف projects/project-id/rulesets/my-ruleset
، نام کوتاه "my-ruleset" را بنویسید. اگر Ruleset
مشخص شده پیدا نشود، با خطای not-found
رد می کند.
امضا:
deleteRuleset(name: string): Promise<void>;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
نام | رشته | نام Ruleset برای حذف. |
برمی گرداند:
قول<باطل>
وعده ای که با حذف Ruleset
محقق می شود.
SecurityRules.getFirestoreRuleset()
مجموعه قوانین را در حال حاضر در Cloud Firestore اعمال می کند. اگر هیچ مجموعه قوانینی در Firestore اعمال نشود، با یک خطای not-found
رد می کند.
امضا:
getFirestoreRuleset(): Promise<Ruleset>;
برمی گرداند:
Promise< مجموعه قوانین >
وعده ای که با مجموعه قوانین Firestore محقق می شود.
SecurityRules.getRuleset()
مجموعه قوانین را با نام مشخص شده مشخص می کند. نام ورودی باید رشته نام کوتاه بدون پیشوند ID پروژه باشد. به عنوان مثال، برای بازیابی projects/project-id/rulesets/my-ruleset
، نام کوتاه "my-ruleset" را بنویسید. اگر Ruleset
مشخص شده پیدا نشود، با خطای not-found
رد می کند.
امضا:
getRuleset(name: string): Promise<Ruleset>;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
نام | رشته | نام Ruleset برای بازیابی. |
برمی گرداند:
Promise< مجموعه قوانین >
وعده ای که با Ruleset
مشخص شده محقق می شود .
SecurityRules.getStorageRuleset()
مجموعه قوانین را در حال حاضر در یک سطل فضای ذخیرهسازی ابری اعمال میکند. اگر مجموعه قوانینی روی سطل اعمال نشود، با یک خطای not-found
رد می کند.
امضا:
getStorageRuleset(bucket?: string): Promise<Ruleset>;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
سطل | رشته | نام اختیاری سطل Cloud Storage که باید بازیابی شود. اگر مشخص نشده باشد، مجموعه قوانین اعمال شده در سطل پیش فرض پیکربندی شده از طریق AppOptions را بازیابی می کند. |
برمی گرداند:
Promise< مجموعه قوانین >
وعده ای که با مجموعه قوانین Cloud Storage محقق می شود.
SecurityRules.listRulesetMetadata()
صفحه ای از ابرداده های مجموعه قوانین را بازیابی می کند.
امضا:
listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
اندازه صفحه | عدد | اندازه صفحه، 100 اگر تعریف نشده باشد. این نیز حداکثر حد مجاز است. |
nextPageToken | رشته | توکن صفحه بعد. اگر مشخص نشده باشد، مجموعه قوانین را که بدون هیچ افست شروع می شوند، برمی گرداند. |
برمی گرداند:
Promise< RulesetMetadataList >
وعده ای که با صفحه ای از مجموعه قوانین محقق می شود.
SecurityRules.releaseFirestoreRuleset()
مجموعه قوانین Ruleset مشخص شده را در Cloud Firestore اعمال می کند.
امضا:
releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
مجموعه قوانین | رشته | RulesetMetadata | نام مجموعه قوانین برای اعمال یا یک شی RulesetMetadata حاوی نام. |
برمی گرداند:
قول<باطل>
وعده ای که با انتشار قوانین اجرا می شود.
SecurityRules.releaseFirestoreRulesetFromSource()
یک Ruleset جدید از منبع داده شده ایجاد می کند و آن را در Cloud Firestore اعمال می کند.
امضا:
releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
منبع | رشته | بافر | منبع قوانین برای اعمال |
برمی گرداند:
Promise< مجموعه قوانین >
وعده ای که با ایجاد و انتشار مجموعه قوانین محقق می شود.
SecurityRules.releaseStorageRuleset()
مجموعه قواعد تعیین شده را در یک سطل ذخیره سازی ابری اعمال می کند.
امضا:
releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
مجموعه قوانین | رشته | RulesetMetadata | نام مجموعه قوانین برای اعمال یا یک شی RulesetMetadata حاوی نام. |
سطل | رشته | نام اختیاری سطل Cloud Storage برای اعمال قوانین. اگر مشخص نشده باشد، مجموعه قوانین را در سطل پیشفرض پیکربندی شده از طریق AppOptions اعمال میکند . |
برمی گرداند:
قول<باطل>
وعده ای که با انتشار قوانین اجرا می شود.
SecurityRules.releaseStorageRulesetFromSource()
یک Ruleset جدید از منبع داده شده ایجاد می کند و آن را در یک سطل ذخیره سازی ابری اعمال می کند.
امضا:
releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
منبع | رشته | بافر | منبع قوانین برای اعمال |
سطل | رشته | نام اختیاری سطل Cloud Storage برای اعمال قوانین. اگر مشخص نشده باشد، مجموعه قوانین را در سطل پیشفرض پیکربندی شده از طریق AppOptions اعمال میکند . |
برمی گرداند:
Promise< مجموعه قوانین >
وعده ای که با ایجاد و انتشار مجموعه قوانین محقق می شود.