firebase-admin.app package

Firebase 應用程式和 SDK 初始化。

函式

函式 說明
applicationDefault(httpAgent) 傳回透過授予 Firebase 服務管理員存取權的 Google 應用程式預設憑證建立的憑證。這個憑證可用於對 InitialApp() 的呼叫。Google 應用程式預設憑證可透過任何 Google 基礎架構使用，例如 Google App Engine 和 Google Compute Engine。詳情請參閱初始化 SDK。
cert(serviceAccountPathOrObject、httpAgent) 傳回從授予 Firebase 服務管理員存取權的所提供服務帳戶中建立的憑證。這組憑證可用於對 InitialApp() 的呼叫。詳情請參閱初始化 SDK。
deleteApp(應用程式) 導致 App 無法使用，並釋放所有關聯服務的資源 (但不會清除任何後端資源)。在本機執行 SDK 時，必須呼叫這個方法，以確保程序安全終止。
getApp(appName)
getApps()
InitialApp(選項, appName)
refreshToken(refreshTokenPathOrObject、httpAgent) 傳回由提供的更新權杖建立的憑證，該權杖會授予 Firebase 服務的管理員存取權。這組憑證可用於對 InitialApp() 的呼叫。詳情請參閱初始化 SDK。

類別

類別 說明
AppErrorCodes 應用程式用戶端錯誤代碼和預設訊息。
FirebaseAppError Firebase 應用程式錯誤代碼結構。這會擴充 PrefixedFirebaseError。

介面

介面 說明
應用程式 Firebase 應用程式會保留一組服務的初始化資訊。
應用程式選項 可傳遞至 InitialApp() 的可用選項。
認證 這個介面會提供 Google OAuth2 存取權杖，用於透過 Firebase 服務進行驗證。在大部分的情況下，您不需要自行實作，可以改用 firebase-admin/app 模組提供的預設實作。
FirebaseArrayIndexError 複合類型，其中包含 FirebaseError 物件和索引，可用於取得發生錯誤的項目。
FirebaseError FirebaseError 是標準 JavaScript Error 物件的子類別。除了訊息字串和堆疊追蹤外，還含有一個字串程式碼。
GoogleOAuthAccessToken Google OAuth 2.0 存取權杖的介面。
ServiceAccount

變數

變數 說明
SDK_VERSION

applicationDefault(httpAgent)

傳回透過授予 Firebase 服務管理員存取權的 Google 應用程式預設憑證建立的憑證。此憑證可用於對 InitialApp() 的呼叫。

Google 應用程式預設憑證適用於所有 Google 基礎架構，例如 Google App Engine 和 Google Compute Engine。

詳情請參閱「初始化 SDK」。

簽名：

export declare function applicationDefault(httpAgent?: Agent): Credential;

參數

參數 類型 說明
httpAgent 代理程式 從 Google 權杖伺服器擷取存取權杖時，會使用選用的 HTTP 代理程式。

傳回：

認證

憑證已透過 Google 應用程式預設憑證驗證，可用於初始化應用程式。

範例

initializeApp({
  credential: applicationDefault(),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

cert(serviceAccountPathOrObject、httpAgent)

傳回從授予 Firebase 服務管理員存取權的所提供服務帳戶中建立的憑證。此憑證可用於對 InitialApp() 的呼叫。

詳情請參閱「初始化 SDK」。

簽名：

export declare function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;

參數

參數 類型 說明
serviceAccountPathOrObject 字串 |ServiceAccount 服務帳戶金鑰 JSON 檔案或代表服務帳戶金鑰的物件的路徑。
httpAgent 代理程式 從 Google 權杖伺服器擷取存取權杖時，會使用選用的 HTTP 代理程式。

傳回：

認證

透過提供的服務帳戶驗證的憑證，可用於初始化應用程式。

範例 1

// Providing a path to a service account key JSON file
const serviceAccount = require("path/to/serviceAccountKey.json");
initializeApp({
  credential: cert(serviceAccount),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

範例 2

// Providing a service account object inline
initializeApp({
  credential: cert({
    projectId: "<PROJECT_ID>",
    clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
    privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
  }),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

DeleteApp(應用程式)

導致 App 無法使用，並釋放所有關聯服務的資源 (但不會清除任何後端資源)。在本機執行 SDK 時，必須呼叫這個方法，以確保程序安全終止。

簽名：

export declare function deleteApp(app: App): Promise<void>;

參數

參數 類型 說明
應用程式 應用程式

傳回：

承諾<void>

範例

deleteApp(app)
  .then(function() {
    console.log("App deleted successfully");
  })
  .catch(function(error) {
    console.log("Error deleting app:", error);
  });

getApp(appName)

簽名：

export declare function getApp(appName?: string): App;

參數

參數 類型 說明
應用程式名稱 字串

傳回：

應用程式

getApps()

簽名：

export declare function getApps(): App[];

傳回：

應用程式[]

InitialApp(選項, appName)

簽名：

export declare function initializeApp(options?: AppOptions, appName?: string): App;

參數

參數 類型 說明
選項 應用程式選項
應用程式名稱 字串

傳回：

應用程式

updateToken(refreshTokenPathOrObject、httpAgent)

傳回由提供的更新權杖建立的憑證，該權杖會授予 Firebase 服務的管理員存取權。此憑證可用於對 InitialApp() 的呼叫。

詳情請參閱「初始化 SDK」。

簽名：

export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;

參數

參數 類型 說明
updateTokenPathOrObject 字串 |物體 Google OAuth2 更新憑證 JSON 檔案路徑，或代表 Google OAuth2 更新權杖的物件路徑。
httpAgent 代理程式 從 Google 權杖伺服器擷取存取權杖時，會使用選用的 HTTP 代理程式。

傳回：

認證

透過提供的服務帳戶驗證的憑證，可用於初始化應用程式。

範例

// Providing a path to a refresh token JSON file
const refreshToken = require("path/to/refreshToken.json");
initializeApp({
  credential: refreshToken(refreshToken),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

SDK 版本

簽名：

SDK_VERSION: string