SecurityRules class

واجهة خدمة Firebase SecurityRules .

إمضاء:

export declare class SecurityRules 

ملكيات

طُرق

SecurityRules.app

إمضاء:

readonly app: App;

SecurityRules.createRuleset()

ينشئ مجموعة قواعد جديدة من ملف RulesFile المحدد .

إمضاء:

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

حدود

عائدات:

وعد< مجموعة القواعد >

وعد يتم الوفاء به من خلال Ruleset المنشأة حديثًا .

SecurityRules.createRulesFileFromSource()

ينشئ ملف RulesFile بالاسم والمصدر المحددين. يلقي خطأ إذا كانت أي من الوسائط غير صالحة. هذه عملية محلية، ولا تتضمن أي استدعاءات لواجهة برمجة تطبيقات الشبكة.

إمضاء:

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

حدود

عائدات:

ملف القواعد

مثيل ملف قواعد جديد.

مثال

const source = '// Some rules source';
const rulesFile = admin.securityRules().createRulesFileFromSource(
  'firestore.rules', source);

SecurityRules.deleteRuleset()

يحذف مجموعة القواعد المحددة بالاسم المحدد. يجب أن يكون اسم الإدخال عبارة عن سلسلة اسم قصيرة بدون بادئة معرف المشروع. على سبيل المثال، لحذف projects/project-id/rulesets/my-ruleset ، قم بتمرير الاسم المختصر "مجموعة القواعد الخاصة بي". يتم الرفض بسبب خطأ not-found إذا تعذر العثور على Ruleset المحددة.

إمضاء:

deleteRuleset(name: string): Promise<void>;

حدود

عائدات:

وعد<باطل>

الوعد الذي يتم الوفاء به عند حذف Ruleset .

SecurityRules.getFirestoreRuleset()

الحصول على مجموعة القواعد المطبقة حاليًا على Cloud Firestore. يتم الرفض بسبب خطأ not-found إذا لم يتم تطبيق مجموعة قواعد على Firestore.

إمضاء:

getFirestoreRuleset(): Promise<Ruleset>;

عائدات:

وعد< مجموعة القواعد >

الوعد الذي يفي بمجموعة قواعد Firestore.

SecurityRules.getRuleset()

يحصل على مجموعة القواعد المحددة بالاسم المحدد. يجب أن يكون اسم الإدخال عبارة عن سلسلة اسم قصيرة بدون بادئة معرف المشروع. على سبيل المثال، لاسترداد projects/project-id/rulesets/my-ruleset ، قم بتمرير الاسم المختصر "مجموعة القواعد الخاصة بي". يتم الرفض بسبب خطأ not-found إذا تعذر العثور على Ruleset المحددة.

إمضاء:

getRuleset(name: string): Promise<Ruleset>;

حدود

عائدات:

وعد< مجموعة القواعد >

وعد يفي بمجموعة Ruleset المحددة .

SecurityRules.getStorageRuleset()

الحصول على مجموعة القواعد المطبقة حاليًا على مجموعة التخزين السحابي. يتم الرفض مع وجود خطأ not-found إذا لم يتم تطبيق مجموعة قواعد على المجموعة.

إمضاء:

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

حدود

عائدات:

وعد< مجموعة القواعد >

وعد يتم الوفاء به من خلال مجموعة قواعد التخزين السحابي.

SecurityRules.listRulesetMetadata()

استرداد صفحة من البيانات التعريفية لمجموعة القواعد.

إمضاء:

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

حدود

عائدات:

وعد< RulesetMetadataList >

الوعد الذي يتحقق بصفحة من القواعد.

SecurityRules.releaseFirestoreRuleset()

يطبق مجموعة قواعد مجموعة القواعد المحددة على Cloud Firestore.

إمضاء:

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

حدود

عائدات:

وعد<باطل>

الوعد الذي يتم الوفاء به عند إصدار مجموعة القواعد.

SecurityRules.releaseFirestoreRulesetFromSource()

ينشئ مجموعة قواعد جديدة من المصدر المحدد، ويطبقها على Cloud Firestore.

إمضاء:

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

حدود

عائدات:

وعد< مجموعة القواعد >

وعد يتم الوفاء به عند إنشاء مجموعة القواعد وإصدارها.

SecurityRules.releaseStorageRuleset()

يطبق مجموعة قواعد مجموعة القواعد المحددة على مجموعة التخزين السحابي.

إمضاء:

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

حدود

عائدات:

وعد<باطل>

الوعد الذي يتم الوفاء به عند إصدار مجموعة القواعد.

SecurityRules.releaseStorageRulesetFromSource()

ينشئ مجموعة قواعد جديدة من المصدر المحدد، ويطبقها على مجموعة التخزين السحابي.

إمضاء:

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

حدود

عائدات:

وعد< مجموعة القواعد >

وعد يتم الوفاء به عند إنشاء مجموعة القواعد وإصدارها.