SecurityRules class

Firebase SecurityRules सेवा का इंटरफ़ेस.

हस्ताक्षर:

export declare class SecurityRules 

प्रॉपर्टी

तरीके

SecurityRules.app

हस्ताक्षर:

readonly app: App;

SecurityRules.createRuleset()

दिए गए RulesFile से नया Ruleset बनाता है.

हस्ताक्षर:

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

पैरामीटर

लौटाए जाने वाले प्रॉडक्ट:

वादा<नियमसेट>

एक ऐसा वादा जो नए Ruleset के हिसाब से पूरा किया जाएगा.

SecurityRules.createRulesFileFromSource()

दिए गए नाम और सोर्स के साथ RulesFile बनाता है. अगर कोई भी तर्क अमान्य है, तो गड़बड़ी की जानकारी देता है. यह एक लोकल ऑपरेशन है और इसमें कोई नेटवर्क एपीआई कॉल शामिल नहीं होता.

हस्ताक्षर:

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

पैरामीटर

लौटाए जाने वाले प्रॉडक्ट:

Rulesफ़ाइल

नियम की नई फ़ाइल का इंस्टेंस.

उदाहरण

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

SecurityRules.deleteRuleset()

दिए गए नाम से पहचाने गए नियमसेट को मिटाता है. इनपुट नाम, प्रोजेक्ट आईडी प्रीफ़िक्स के बिना छोटे नाम वाली स्ट्रिंग होना चाहिए. उदाहरण के लिए, projects/project-id/rulesets/my-ruleset मिटाने के लिए, छोटा नाम "my-ruleset" पास करें. तय किया गया Ruleset नहीं मिलने पर, not-found गड़बड़ी के साथ अस्वीकार कर देता है.

हस्ताक्षर:

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

पैरामीटर

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

ऐसा प्रॉमिस जो Ruleset को मिटाए जाने के बाद पूरा किया जाता है.

SecurityRules.getFirestoreRuleset()

Cloud Firestore पर लागू किए गए नियमसेट को लागू करता है. अगर Firestore पर कोई नियमसेट लागू नहीं होता है, तो यह not-found गड़बड़ी के साथ अस्वीकार हो जाएगा.

हस्ताक्षर:

getFirestoreRuleset(): Promise<Ruleset>;

लौटाए जाने वाले प्रॉडक्ट:

वादा<नियमसेट>

एक ऐसा प्रॉमिस जो Firestore के नियमों के मुताबिक पूरा करता हो.

SecurityRules.getRuleset()

दिए गए नाम से पहचाने गए नियमसेट को हासिल करता है. इनपुट नाम, प्रोजेक्ट आईडी प्रीफ़िक्स के बिना छोटे नाम वाली स्ट्रिंग होना चाहिए. उदाहरण के लिए, projects/project-id/rulesets/my-ruleset को फिर से पाने के लिए, छोटा नाम "my-ruleset" पास करें. तय किया गया Ruleset नहीं मिलने पर, not-found गड़बड़ी के साथ अस्वीकार कर देता है.

हस्ताक्षर:

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

पैरामीटर

लौटाए जाने वाले प्रॉडक्ट:

वादा<नियमसेट>

ऐसा प्रॉमिस जो Ruleset में बताई गई शर्तों को पूरा करता है.

SecurityRules.getStorageRuleset()

Cloud Storage बकेट पर लागू किए गए मौजूदा नियमसेट को फ़ेच करता है. अगर बकेट पर कोई नियमसेट लागू नहीं होता है, तो not-found गड़बड़ी के साथ अस्वीकार हो जाता है.

हस्ताक्षर:

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

पैरामीटर

लौटाए जाने वाले प्रॉडक्ट:

वादा<नियमसेट>

ऐसा प्रॉमिस जो Cloud Storage के नियमसेट के मुताबिक पूरा होता हो.

SecurityRules.listRulesetMetadata()

नियमसेट मेटाडेटा का पेज वापस लाता है.

हस्ताक्षर:

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

पैरामीटर

लौटाए जाने वाले प्रॉडक्ट:

Promise<RulesetMetadataList>

एक ऐसा प्रॉमिस जो नियमों के सेट के पेज के साथ पूरा होता है.

SecurityRules.releaseFirestoreRuleset()

तय किए गए नियमसेट को Cloud Firestore पर लागू करता है.

हस्ताक्षर:

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

पैरामीटर

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

एक ऐसा प्रॉमिस जो नियमसेट के रिलीज़ होने पर पूरा होता है.

SecurityRules.releaseFirestoreRulesetFromSource()

दिए गए सोर्स से एक नया नियमसेट बनाता है और उसे Cloud Firestore पर लागू करता है.

हस्ताक्षर:

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

पैरामीटर

लौटाए जाने वाले प्रॉडक्ट:

वादा<नियमसेट>

एक ऐसा प्रॉमिस जो नियमसेट के बनने और रिलीज़ होने पर पूरा होता है.

SecurityRules.releaseStorageRuleset()

Cloud Storage बकेट पर तय किए गए नियमसेट के नियमसेट को लागू करता है.

हस्ताक्षर:

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

पैरामीटर

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

एक ऐसा प्रॉमिस जो नियमसेट के रिलीज़ होने पर पूरा होता है.

SecurityRules.ReleaseStorageRulesetFromSource()

दिए गए सोर्स से एक नया नियमसेट बनाता है और उसे Cloud Storage बकेट पर लागू करता है.

हस्ताक्षर:

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

पैरामीटर

लौटाए जाने वाले प्रॉडक्ट:

वादा<नियमसेट>

एक ऐसा प्रॉमिस जो नियमों कासेट बनने और रिलीज़ होने पर पूरा होता है.