AppOptions interface

可傳遞至 InitialApp() 的可用選項。

簽名:

export interface AppOptions 

屬性

屬性 類型 說明
憑證 認證 用於驗證 Admin SDK 的 Credential 物件。如需詳細的說明文件和程式碼範例,請參閱「初始化 SDK」。
databaseAuthVariableOverride 物件 |空值 Admin SDK 讀取或寫入即時資料庫時,要當做即時資料庫規則中「auth」變數的物件。這麼做可讓您將 Admin SDK 的預設完整讀取和寫入權限縮小範圍。您可以傳遞 null 做為未經驗證的用戶端。如需詳細說明文件和程式碼範例,請參閱以有限權限進行驗證
databaseURL 字串 要讀取及寫入資料的即時資料庫網址。
httpAgent 代理程式 撥出 HTTP 呼叫時使用的 HTTP 代理程式。所有進行 REST 呼叫的服務 (例如 authmessagingprojectManagement) 都會使用這個代理程式執行個體。即時資料庫和 Firestore 透過其他方式與後端伺服器通訊,因此不會使用這個 HTTP 代理程式。Credential 執行個體也不使用這個 HTTP 代理程式,而是支援在對應的工廠方法中指定 HTTP 代理程式。
projectId 字串 與應用程式相關聯的 Google Cloud 專案 ID。
serviceAccountId 字串 用來簽署自訂權杖的服務帳戶 ID。這個 ID 在服務帳戶 JSON 檔案的 client_email 欄位中。
storage 值區 字串 用來儲存應用程式資料的 Google Cloud Storage 值區名稱。請只使用值區名稱,不要加上前置字元或額外文字 (但名稱前應「不要」在名稱前面加上「gs://」)。

AppOptions.credential

用於驗證 Admin SDK 的 Credential 物件。

如需詳細的說明文件和程式碼範例,請參閱「初始化 SDK」。

簽名:

credential?: Credential;

AppOptions.databaseAuthVariableOverride

Admin SDK 讀取或寫入即時資料庫時,要當做即時資料庫規則中「auth」變數的物件。這麼做可將 Admin SDK 的預設讀取和寫入權限縮小。

您可以傳遞 null 做為未經驗證的用戶端。

如需詳細說明文件和程式碼範例,請參閱「以有限的權限進行驗證」。

簽名:

databaseAuthVariableOverride?: object | null;

AppOptions.databaseURL

要讀取及寫入資料的即時資料庫網址。

簽名:

databaseURL?: string;

AppOptions.httpAgent

撥出 HTTP 呼叫時使用的 HTTP 代理程式。所有進行 REST 呼叫的服務 (例如 authmessagingprojectManagement) 都會使用這個代理程式執行個體。

即時資料庫和 Firestore 透過其他方式與後端伺服器通訊,因此不會使用這個 HTTP 代理程式。Credential 執行個體也不使用這個 HTTP 代理程式,而是支援在對應的工廠方法中指定 HTTP 代理程式。

簽名:

httpAgent?: Agent;

AppOptions.projectId

與應用程式相關聯的 Google Cloud 專案 ID。

簽名:

projectId?: string;

AppOptions.serviceAccountId

用來簽署自訂權杖的服務帳戶 ID。這個 ID 在服務帳戶 JSON 檔案的 client_email 欄位中。

簽名:

serviceAccountId?: string;

AppOptions.storageBucket

用來儲存應用程式資料的 Google Cloud Storage 值區名稱。請只使用值區名稱,不要加上前置字元或額外文字 (但名稱前應「不要」在名稱前面加上「gs://」)。

簽名:

storageBucket?: string;