SecurityRules class

Firebase SecurityRules服務介面。

簽名：

export declare class SecurityRules 

特性

方法

安全規則.app

簽名：

readonly app: App;

SecurityRules.createRuleset()

從給定的規則檔案建立新的規則集。

簽名：

createRuleset(file: RulesFile): Promise<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()

刪除由給定名稱標識的規則集。輸入名稱應該是不含項目 ID 前綴的短名稱字串。例如，刪除projects/project-id/rulesets/my-ruleset ，傳遞短名稱“my-ruleset”。如果not-found指定的Ruleset集，則拒絕並顯示未找到錯誤。

簽名：

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

參數

返回：

承諾<無效>

當Ruleset被刪除時所履行的承諾。

SecurityRules.getFirestoreRuleset()

取得目前應用於 Cloud Firestore 的規則集。如果 Firestore 上未套用任何規則集，則會拒絕並顯示not-found錯誤。

簽名：

getFirestoreRuleset(): Promise<Ruleset>;

返回：

承諾<規則集>

符合 Firestore 規則集的承諾。

SecurityRules.getRuleset()

取得由給定名稱標識的規則集。輸入名稱應該是不含項目 ID 前綴的短名稱字串。例如，檢索projects/project-id/rulesets/my-ruleset ，傳遞短名稱“my-ruleset”。如果not-found指定的Ruleset集，則拒絕並顯示未找到錯誤。

簽名：

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

參數

返回：

承諾<規則集>

滿足指定Ruleset的承諾。

SecurityRules.getStorageRuleset()

取得目前應用於 Cloud Storage 儲存桶的規則集。如果沒有在儲存桶上套用規則集，則會拒絕並顯示not-found錯誤。

簽名：

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

參數

返回：

承諾<規則集>

雲端儲存規則集兌現了這項承諾。

SecurityRules.listRulesetMetadata()

檢索規則集元資料頁面。

簽名：

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

參數

返回：

Promise<規則集元資料列表>

一個透過一頁規則集實現的承諾。

SecurityRules.releaseFirestoreRuleset()

將指定的規則集套用到 Cloud Firestore。

簽名：

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

參數

返回：

承諾<無效>

規則集發佈時兌現的承諾。

SecurityRules.releaseFirestoreRulesetFromSource()

從給定來源建立新規則集，並將其套用到 Cloud Firestore。

簽名：

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

參數

返回：

承諾<規則集>

建立和發布規則集時履行的承諾。

SecurityRules.releaseStorageRuleset()

將指定的規則集套用到 Cloud Storage 儲存分區。

簽名：

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

參數

返回：

承諾<無效>

規則集發佈時兌現的承諾。

SecurityRules.releaseStorageRulesetFromSource()

從給定來源建立新規則集，並將其套用到 Cloud Storage 儲存分區。

簽名：

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

參數

返回：

承諾<規則集>

建立和發布規則集時履行的承諾。