firebase-admin.security-rules package

Cloud Firestore 和 Cloud Storage 的安全性規則。

函式

函式 說明
getSecurityRules(應用程式) 取得預設應用程式或特定應用程式的 SecurityRules 服務。不需引數即可呼叫 admin.securityRules(),藉此存取預設應用程式的 SecurityRules 服務,也可使用 admin.securityRules(app) 搭配 admin.securityRules(app),存取與特定應用程式相關聯的 SecurityRules 服務。

類別

類別 說明
規則集 一組 Firebase 安全性規則。
規則集中繼資料清單 一頁規則集中繼資料。
SecurityRules Firebase SecurityRules 服務介面。

介面

介面 說明
規則集中繼資料 與規則集相關聯的必要中繼資料。
規則檔案 包含一些 Firebase 安全性規則的來源檔案。內容包括文字格式、縮排和註解等原始原始碼。使用 SecurityRules.createRulesFileFromSource() 方法建立新的這種類型的執行個體。

getSecurityRules(應用程式)

取得預設應用程式或特定應用程式的 SecurityRules 服務。

呼叫 admin.securityRules() 時無需引數即可存取預設應用程式的 SecurityRules 服務,也可使用 admin.securityRules(app) 的形式呼叫,存取與特定應用程式相關聯的 SecurityRules 服務。

簽名:

export declare function getSecurityRules(app?: App): SecurityRules;

參數

參數 類型 說明
應用程式 應用程式 用來傳回 SecurityRules 服務的選用應用程式。如未提供,系統會傳回預設的 SecurityRules 服務。

傳回:

SecurityRules

如未提供應用程式,或與提供應用程式相關聯的 SecurityRules 服務,則預設的 SecurityRules 服務。

範例 1

// Get the SecurityRules service for the default app
const defaultSecurityRules = getSecurityRules();

範例 2

// Get the SecurityRules service for a given app
const otherSecurityRules = getSecurityRules(otherApp);