SecurityRules class

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

Signature:

export declare class SecurityRules 

أماكن إقامة

الطُرق

تطبيق SecurityRules.app

Signature:

readonly app: App;

SecurityRules.createRuleset()

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

Signature:

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

المَعلمات

المرتجعات:

الوعد<Ruleset>

يفي بهذا الوعد مع Ruleset الذي تم إنشاؤه حديثًا.

SecurityRules.createRulesFileFromSource()

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

Signature:

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

المَعلمات

المرتجعات:

RulesFile

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

مثال

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

SecurityRules.deleteRuleset()

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

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

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

SecurityRules.getFirestoreRuleset()

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

Signature:

getFirestoreRuleset(): Promise<Ruleset>;

المرتجعات:

الوعد<Ruleset>

الوعد الذي يفي بشروط مجموعة Firestore

SecurityRules.getRuleset()

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

Signature:

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

المَعلمات

المرتجعات:

الوعد<Ruleset>

الوعد الذي يتم الوفاء به مع Ruleset المحدّدة

SecurityRules.getStorageRuleset()

الحصول على مجموعة القواعد المطبَّقة حاليًا على حزمة في Cloud Storage يتم الرفض مع ظهور الخطأ not-found في حال عدم تطبيق أي مجموعة قواعد على الحزمة.

Signature:

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

المَعلمات

المرتجعات:

الوعد<Ruleset>

هو وعد يفي بمعايير مجموعة قواعد Cloud Storage.

SecurityRules.listRulesetMetadata()

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

Signature:

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

المَعلمات

المرتجعات:

وعود <RulesetMetadataList>

الوعد الذي يفي بالغرض من خلال صفحة من مجموعات القواعد

SecurityRules.releaseFirestoreRuleset()

يطبِّق هذا الخيار مجموعة قواعد القواعد المحدَّدة على Cloud Firestore.

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

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

SecurityRules.releaseFirestoreRulesetFromSource()

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

Signature:

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

المَعلمات

المرتجعات:

الوعد<Ruleset>

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

SecurityRules.releaseStorageRuleset()

يتيح هذا الخيار تطبيق مجموعة قواعد مجموعة القواعد المحدّدة على حزمة في Cloud Storage.

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

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

SecurityRules.ReleaseStorageRulesetFromSource()

تنشئ مجموعة قواعد جديدة من المصدر المحدّد وتطبّقها على حزمة على Cloud Storage.

Signature:

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

المَعلمات

المرتجعات:

الوعد<Ruleset>

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