Firebase SecurityRules
পরিষেবা ইন্টারফেস।
স্বাক্ষর:
export declare class SecurityRules
বৈশিষ্ট্য
সম্পত্তি | সংশোধক | টাইপ | বর্ণনা |
---|---|---|---|
অ্যাপ | অ্যাপ |
পদ্ধতি
পদ্ধতি | সংশোধক | বর্ণনা |
---|---|---|
createRuleset(ফাইল) | প্রদত্ত RulesFile থেকে একটি নতুন Ruleset তৈরি করে . | |
CreateRulesFileFromSource(নাম, উৎস) | প্রদত্ত নাম এবং উত্স সহ একটি RulesFile তৈরি করে। কোন আর্গুমেন্ট অবৈধ হলে একটি ত্রুটি নিক্ষেপ করে। এটি একটি স্থানীয় অপারেশন, এবং কোনো নেটওয়ার্ক API কল জড়িত নয়। | |
ডিলিট রুলসেট(নাম) | প্রদত্ত নামের দ্বারা চিহ্নিত রুলসেট মুছে দেয়। ইনপুট নামটি প্রজেক্ট আইডি উপসর্গ ছাড়াই ছোট নামের স্ট্রিং হওয়া উচিত। উদাহরণস্বরূপ, projects/project-id/rulesets/my-ruleset মুছে ফেলতে, ছোট নাম "my-ruleset" পাস করুন। যদি নির্দিষ্ট Ruleset না পাওয়া যায় তাহলে একটি not-found ত্রুটির সাথে প্রত্যাখ্যান করে। | |
getFirestoreRuleset() | ক্লাউড ফায়ারস্টোরে বর্তমানে প্রয়োগ করা নিয়মসেট পায়। ফায়ারস্টোরে কোনো রুলসেট প্রয়োগ করা not-found ত্রুটির সাথে প্রত্যাখ্যান করে। | |
getRuleset(নাম) | প্রদত্ত নাম দ্বারা শনাক্ত করা নিয়ম সেট পায়। ইনপুট নামটি প্রজেক্ট আইডি উপসর্গ ছাড়াই ছোট নামের স্ট্রিং হওয়া উচিত। উদাহরণ স্বরূপ, projects/project-id/rulesets/my-ruleset পুনরুদ্ধার করতে, ছোট নাম "মাই-রুলসেট" পাস করুন। যদি নির্দিষ্ট Ruleset না পাওয়া যায় তাহলে একটি not-found ত্রুটির সাথে প্রত্যাখ্যান করে। | |
getStorageRuleset(বালতি) | বর্তমানে একটি ক্লাউড স্টোরেজ বালতিতে প্রয়োগ করা নিয়মসেট পায়। বালতিতে কোনো রুলসেট প্রয়োগ করা not-found ত্রুটির সাথে প্রত্যাখ্যান করে। | |
listRulesetMetadata(পৃষ্ঠার আকার, NextPageToken) | রুলসেট মেটাডেটার একটি পৃষ্ঠা পুনরুদ্ধার করে। | |
releaseFirestoreRuleset(রুলসেট) | ক্লাউড ফায়ারস্টোরে নির্দিষ্ট রুলসেট রুলসেট প্রয়োগ করে। | |
releaseFirestoreRulesetFromSource(উৎস) | প্রদত্ত উত্স থেকে একটি নতুন নিয়ম সেট তৈরি করে এবং এটি ক্লাউড ফায়ারস্টোরে প্রয়োগ করে। | |
releaseStorageRuleset(রুলসেট, বালতি) | একটি ক্লাউড স্টোরেজ বালতিতে নির্দিষ্ট রুলসেট রুলসেট প্রয়োগ করে। | |
releaseStorageRulesetFromSource(উৎস, বালতি) | প্রদত্ত উত্স থেকে একটি নতুন নিয়ম সেট তৈরি করে এবং এটি একটি ক্লাউড স্টোরেজ বালতিতে প্রয়োগ করে৷ |
SecurityRules.app
স্বাক্ষর:
readonly app: App;
SecurityRules.createRuleset()
প্রদত্ত RulesFile থেকে একটি নতুন Ruleset তৈরি করে .
স্বাক্ষর:
createRuleset(file: RulesFile): Promise<Ruleset>;
পরামিতি
প্যারামিটার | টাইপ | বর্ণনা |
---|---|---|
ফাইল | নিয়ম ফাইল | নিয়ম ফাইল নতুন Ruleset অন্তর্ভুক্ত. |
রিটার্ন:
প্রতিশ্রুতি< নিয়ম সেট >
একটি প্রতিশ্রুতি যা সদ্য নির্মিত 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()
প্রদত্ত নামের দ্বারা চিহ্নিত রুলসেট মুছে দেয়। ইনপুট নামটি প্রজেক্ট আইডি উপসর্গ ছাড়াই ছোট নামের স্ট্রিং হওয়া উচিত। উদাহরণস্বরূপ, projects/project-id/rulesets/my-ruleset
মুছে ফেলার জন্য , সংক্ষিপ্ত নাম "my-ruleset" পাস করুন। যদি নির্দিষ্ট Ruleset
না পাওয়া যায় তাহলে একটি not-found
ত্রুটির সাথে প্রত্যাখ্যান করে।
স্বাক্ষর:
deleteRuleset(name: string): Promise<void>;
পরামিতি
প্যারামিটার | টাইপ | বর্ণনা |
---|---|---|
নাম | স্ট্রিং | মুছে ফেলার Ruleset নাম। |
রিটার্ন:
প্রতিশ্রুতি <void>
একটি প্রতিশ্রুতি যা পূরণ করে যখন Ruleset
মুছে ফেলা হয়।
SecurityRules.getFirestoreRuleset()
ক্লাউড ফায়ারস্টোরে বর্তমানে প্রয়োগ করা নিয়মসেট পায়। ফায়ারস্টোরে কোনো রুলসেট প্রয়োগ করা 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 নাম। |
রিটার্ন:
প্রতিশ্রুতি< নিয়ম সেট >
একটি প্রতিশ্রুতি যা নির্দিষ্ট Ruleset
সাথে পূরণ করে .
SecurityRules.getStorageRuleset()
বর্তমানে একটি ক্লাউড স্টোরেজ বালতিতে প্রয়োগ করা নিয়মসেট পায়। বালতিতে কোনো রুলসেট প্রয়োগ করা not-found
ত্রুটির সাথে প্রত্যাখ্যান করে।
স্বাক্ষর:
getStorageRuleset(bucket?: string): Promise<Ruleset>;
পরামিতি
প্যারামিটার | টাইপ | বর্ণনা |
---|---|---|
বালতি | স্ট্রিং | ক্লাউড স্টোরেজ বাকেটের ঐচ্ছিক নাম পুনরুদ্ধার করা হবে। নির্দিষ্ট করা না থাকলে, AppOptions মাধ্যমে কনফিগার করা ডিফল্ট বাকেটের উপর প্রয়োগ করা নিয়মসেট পুনরুদ্ধার করে। |
রিটার্ন:
প্রতিশ্রুতি< নিয়ম সেট >
একটি প্রতিশ্রুতি যা ক্লাউড স্টোরেজ নিয়মের সাথে পূরণ করে।
SecurityRules.listRulesetMetadata()
রুলসেট মেটাডেটার একটি পৃষ্ঠা পুনরুদ্ধার করে।
স্বাক্ষর:
listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
পরামিতি
প্যারামিটার | টাইপ | বর্ণনা |
---|---|---|
পাতার আকার | সংখ্যা | পৃষ্ঠার আকার, 100 যদি অনির্ধারিত হয়। এটিও সর্বাধিক অনুমোদিত সীমা। |
nextPageToken | স্ট্রিং | পরের পাতা টোকেন. নির্দিষ্ট করা না থাকলে, কোনো অফসেট ছাড়াই শুরু করে রুলসেট ফেরত দেয়। |
রিটার্ন:
প্রতিশ্রুতি< RulesetMetadataList >
একটি প্রতিশ্রুতি যা নিয়মের একটি পৃষ্ঠার সাথে পূরণ করে।
SecurityRules.releaseFirestoreRuleset()
ক্লাউড ফায়ারস্টোরে নির্দিষ্ট রুলসেট রুলসেট প্রয়োগ করে।
স্বাক্ষর:
releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
পরামিতি
প্যারামিটার | টাইপ | বর্ণনা |
---|---|---|
নিয়ম | স্ট্রিং | রুলসেট মেটাডেটা | প্রয়োগ করার নিয়ম সেটের নাম বা নাম ধারণকারী একটি RulesetMetadata অবজেক্ট। |
রিটার্ন:
প্রতিশ্রুতি <void>
একটি প্রতিশ্রুতি যা রুলসেট প্রকাশিত হলে পূরণ হয়।
SecurityRules.releaseFirestoreRulesetFromSource()
প্রদত্ত উত্স থেকে একটি নতুন নিয়ম সেট তৈরি করে এবং এটি ক্লাউড ফায়ারস্টোরে প্রয়োগ করে।
স্বাক্ষর:
releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;
পরামিতি
প্যারামিটার | টাইপ | বর্ণনা |
---|---|---|
উৎস | স্ট্রিং | বাফার | প্রয়োগের নিয়ম সূত্র। |
রিটার্ন:
প্রতিশ্রুতি< নিয়ম সেট >
একটি প্রতিশ্রুতি যা পরিপূর্ণ হয় যখন রুলসেট তৈরি এবং প্রকাশ করা হয়।
SecurityRules.releaseStorageRuleset()
একটি ক্লাউড স্টোরেজ বালতিতে নির্দিষ্ট রুলসেট রুলসেট প্রয়োগ করে।
স্বাক্ষর:
releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
পরামিতি
প্যারামিটার | টাইপ | বর্ণনা |
---|---|---|
নিয়ম | স্ট্রিং | রুলসেট মেটাডেটা | প্রয়োগ করার নিয়ম সেটের নাম বা নাম ধারণকারী একটি RulesetMetadata অবজেক্ট। |
বালতি | স্ট্রিং | ক্লাউড স্টোরেজ বাকেটের ঐচ্ছিক নাম নিয়ম প্রয়োগ করতে। নির্দিষ্ট করা না থাকলে, AppOptions এর মাধ্যমে কনফিগার করা ডিফল্ট বালতিতে রুলসেট প্রয়োগ করে . |
রিটার্ন:
প্রতিশ্রুতি <void>
একটি প্রতিশ্রুতি যা রুলসেট প্রকাশিত হলে পূরণ হয়।
SecurityRules.releaseStorageRulesetFromSource()
প্রদত্ত উত্স থেকে একটি নতুন নিয়ম সেট তৈরি করে এবং এটি একটি ক্লাউড স্টোরেজ বালতিতে প্রয়োগ করে৷
স্বাক্ষর:
releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
পরামিতি
প্যারামিটার | টাইপ | বর্ণনা |
---|---|---|
উৎস | স্ট্রিং | বাফার | প্রয়োগের নিয়ম সূত্র। |
বালতি | স্ট্রিং | ক্লাউড স্টোরেজ বাকেটের ঐচ্ছিক নাম নিয়ম প্রয়োগ করতে। নির্দিষ্ট করা না থাকলে, AppOptions এর মাধ্যমে কনফিগার করা ডিফল্ট বালতিতে রুলসেট প্রয়োগ করে . |
রিটার্ন:
প্রতিশ্রুতি< নিয়ম সেট >
একটি প্রতিশ্রুতি যা পরিপূর্ণ হয় যখন রুলসেট তৈরি এবং প্রকাশ করা হয়।