SecurityRules class

رابط سرویس Firebase SecurityRules .

امضا:

export declare class SecurityRules 

خواص

مواد و روش ها

SecurityRules.app

امضا:

readonly app: App;

SecurityRules.createRuleset()

یک مجموعه قوانین جدید از RulesFile داده شده ایجاد می کند .

امضا:

createRuleset(file: RulesFile): Promise<Ruleset>;

مولفه های

برمی گرداند:

Promise< مجموعه قوانین >

وعده ای که با Ruleset جدید ایجاد شده محقق می شود .

SecurityRules.createRulesFileFromSource()

یک RulesFile با نام و منبع داده شده ایجاد می کند. اگر هر یک از آرگومان ها نامعتبر باشد، خطا می دهد. این یک عملیات محلی است و شامل هیچ تماس API شبکه نمی شود.

امضا:

createRulesFileFromSource(name: string, source: string | Buffer): RulesFile;

مولفه های

برمی گرداند:

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 محقق می شود.

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>;

مولفه های

برمی گرداند:

Promise< مجموعه قوانین >

وعده ای که با Ruleset مشخص شده محقق می شود .

SecurityRules.getStorageRuleset()

مجموعه قوانین را در حال حاضر در یک سطل فضای ذخیره‌سازی ابری اعمال می‌کند. اگر مجموعه قوانینی روی سطل اعمال نشود، با یک خطای not-found رد می کند.

امضا:

getStorageRuleset(bucket?: string): Promise<Ruleset>;

مولفه های

برمی گرداند:

Promise< مجموعه قوانین >

وعده ای که با مجموعه قوانین Cloud Storage محقق می شود.

SecurityRules.listRulesetMetadata()

صفحه ای از ابرداده های مجموعه قوانین را بازیابی می کند.

امضا:

listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;

مولفه های

برمی گرداند:

Promise< RulesetMetadataList >

وعده ای که با صفحه ای از مجموعه قوانین محقق می شود.

SecurityRules.releaseFirestoreRuleset()

مجموعه قوانین Ruleset مشخص شده را در Cloud Firestore اعمال می کند.

امضا:

releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;

مولفه های

برمی گرداند:

قول<باطل>

وعده ای که با انتشار قوانین اجرا می شود.

SecurityRules.releaseFirestoreRulesetFromSource()

یک Ruleset جدید از منبع داده شده ایجاد می کند و آن را در Cloud Firestore اعمال می کند.

امضا:

releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;

مولفه های

برمی گرداند:

Promise< مجموعه قوانین >

وعده ای که با ایجاد و انتشار مجموعه قوانین محقق می شود.

SecurityRules.releaseStorageRuleset()

مجموعه قواعد تعیین شده را در یک سطل ذخیره سازی ابری اعمال می کند.

امضا:

releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;

مولفه های

برمی گرداند:

قول<باطل>

وعده ای که با انتشار قوانین اجرا می شود.

SecurityRules.releaseStorageRulesetFromSource()

یک Ruleset جدید از منبع داده شده ایجاد می کند و آن را در یک سطل ذخیره سازی ابری اعمال می کند.

امضا:

releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;

مولفه های

برمی گرداند:

Promise< مجموعه قوانین >

وعده ای که با ایجاد و انتشار مجموعه قوانین محقق می شود.