Firebase 命名空間 API (舊版)。
函式
| 函式 | 說明 |
|---|---|
| <應用程式名稱> | |
| appCheck(應用程式) | 取得適用於預設應用程式或特定應用程式的 AppCheck 服務。admin.appCheck()無需引數即可存取預設應用程式的 AppCheck 服務，或以 admin.appCheck(app) 特定服務使用AppCheck與該服務相關聯的應用程式。 |
| auth(應用程式) | 取得預設應用程式或特定應用程式的驗證服務。不需引數即可呼叫 admin.auth()，藉此存取預設應用程式的驗證服務，使用 admin.auth(app) 存取與特定應用程式相關聯的 Auth 服務。 |
| database(應用程式) | 取得預設應用程式或特定應用程式的資料庫服務。在不使用引數的情況下呼叫 admin.database()，即可存取預設應用程式的 Database 服務，或以 admin.database(app) 的形式呼叫 admin.database()，藉此存取與特定應用程式相關聯的 Database 服務。admin.database 也是可用於存取與 Database 服務相關聯的全域常數和方法的命名空間。 |
| Firestore(應用程式) | |
| InitialApp(選項, 名稱) | |
| installations(應用程式) | 取得預設應用程式或特定應用程式的安裝服務。在不使用引數的情況下呼叫 admin.installations()，即可存取預設應用程式的「安裝」服務，使用 admin.installations(app) 存取與特定應用程式相關聯的安裝服務。 |
| instanceId(應用程式) | 取得預設應用程式或特定應用程式的 InstanceId 服務。admin.instanceId()無需引數即可存取預設應用程式的 InstanceId 服務，或以 admin.instanceId(app) 特定服務來存取 InstanceId 特定服務。 |
| machineLearning(應用程式) | 取得適用於預設應用程式或指定應用程式的機器學習服務。admin.machineLearning()無需引數即可存取預設應用程式的 MachineLearning 服務，或以 admin.machineLearning(app) 特定應用程式的方式存取該服務MachineLearning。 |
| 訊息(應用程式) | 取得預設應用程式或特定應用程式的訊息服務。admin.messaging() 在無需引數的情況下呼叫 admin.messaging()，即可存取預設應用程式的 Messaging 服務，也可使用 admin.messaging(app) 存取與特定應用程式相關聯的 Messaging 服務。 |
| projectManagement(應用程式) | 取得預設應用程式或特定應用程式的 ProjectManagement 服務。在不需引數的情況下呼叫 admin.projectManagement()，即可存取預設應用程式的 ProjectManagement 服務，或使用 admin.projectManagement(app) 存取與特定應用程式相關聯的 ProjectManagement 服務。 |
| remoteConfig(應用程式) | 取得預設應用程式或特定應用程式的 RemoteConfig 服務。admin.remoteConfig()無需引數即可存取預設應用程式的 RemoteConfig 服務，或以 admin.remoteConfig(app) 的方式存取與 RemoteConfig 相關聯的特定應用程式。 |
| securityRules(應用程式) | 取得預設應用程式或特定應用程式的 SecurityRules 服務。呼叫 admin.securityRules() 時無需引數，即可存取預設應用程式的 SecurityRules 服務，也可使用 admin.securityRules(app) 存取與特定應用程式相關聯的 SecurityRules 服務。 |
| 儲存空間(應用程式) | 取得預設應用程式或特定應用程式的 Storage 服務。使用 admin.storage() 呼叫 admin.storage() 時，不必引數即可存取預設應用程式的 Storage 服務，也可使用 admin.storage(app) 存取與特定應用程式相關聯的 Storage 服務。 |
介面
| 介面 | 說明 |
|---|---|
| 應用程式選項 | 可傳遞至 InitialApp() 的可用選項。 |
| FirebaseArrayIndexError | 複合類型，其中包含 FirebaseError 物件和索引，可用於取得發生錯誤的項目。 |
| FirebaseError | FirebaseError 是標準 JavaScript Error 物件的子類別。除了訊息字串和堆疊追蹤外，還含有一個字串程式碼。 |
| GoogleOAuthAccessToken | Google OAuth 2.0 存取權杖的介面。 |
| ServiceAccount |
命名空間
| 命名空間 | 說明 |
|---|---|
| 應用程式 | |
| appCheck | |
| 驗證 | |
| 憑證 | |
| 資料庫 | |
| Firestore | |
| 安裝次數 | |
| instanceId | |
| 機器學習 | |
| 訊息 | |
| projectManagement | |
| remoteConfig | |
| securityRules | |
| 儲存空間 |
變數
| 變數 | 說明 |
|---|---|
| 應用程式 | |
| SDK_VERSION |
app(名稱)
簽名：
export declare function app(name?: string): app.App;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 名稱 | 字串 |
傳回：
appCheck(應用程式)
取得預設應用程式或特定應用程式的 AppCheck 服務。
呼叫 admin.appCheck() 時無需引數即可存取預設應用程式的 AppCheck 服務，也可使用 admin.appCheck(app) 形式呼叫，藉此存取與特定應用程式相關聯的 AppCheck 服務。
簽名：
export declare function appCheck(app?: App): appCheck.AppCheck;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | 應用程式 | 用於傳回 AppCheck 服務的選用應用程式。如未提供，系統會傳回預設的 AppCheck 服務。 |
傳回：
如未提供應用程式，或與提供應用程式相關聯的 AppCheck 服務，則預設的 AppCheck 服務。
範例 1
// Get the `AppCheck` service for the default app
var defaultAppCheck = admin.appCheck();
範例 2
// Get the `AppCheck` service for a given app
var otherAppCheck = admin.appCheck(otherApp);
auth(應用程式)
取得預設應用程式或特定應用程式的 Auth 服務。
呼叫 admin.auth() 時無需引數，即可存取預設應用程式的 Auth 服務，也可使用 admin.auth(app) 形式呼叫，存取與特定應用程式相關聯的 Auth 服務。
簽名：
export declare function auth(app?: App): auth.Auth;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | 應用程式 |
傳回：
範例 1
// Get the Auth service for the default app
var defaultAuth = admin.auth();
範例 2
// Get the Auth service for a given app
var otherAuth = admin.auth(otherApp);
資料庫(應用程式)
取得預設應用程式或特定應用程式的資料庫服務。
呼叫 admin.database() 時無需引數即可存取預設應用程式的 Database 服務，也可使用 admin.database(app) 形式呼叫，藉此存取與特定應用程式相關聯的 Database 服務。
admin.database 也是命名空間，可用來存取與 Database 服務相關聯的全域常數和方法。
簽名：
export declare function database(app?: App): database.Database;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | 應用程式 |
傳回：
如未提供應用程式，或是與提供應用程式相關聯的 Database 服務，則預設的 Database 服務。
範例 1
// Get the Database service for the default app
var defaultDatabase = admin.database();
範例 2
// Get the Database service for a specific app
var otherDatabase = admin.database(app);
Firestore(應用程式)
簽名：
export declare function firestore(app?: App): _firestore.Firestore;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | 應用程式 |
傳回：
_Firestore.Firestore
InitialApp(選項, 名稱)
簽名：
export declare function initializeApp(options?: AppOptions, name?: string): app.App;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 選項 | 應用程式選項 | |
| 名稱 | 字串 |
傳回：
安裝(應用程式)
呼叫 admin.installations() 時無需引數即可存取預設應用程式的「安裝」服務，也可使用 admin.installations(app) 的形式呼叫，存取與特定應用程式相關聯的安裝服務。
簽名：
export declare function installations(app?: App): installations.Installations;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | 應用程式 | 要傳回其 Installations 服務的選用應用程式。如未提供，系統會傳回預設的 Installations 服務。 |
傳回：
如未提供應用程式，或是與提供應用程式相關聯的 Installations 服務，則預設的 Installations 服務。
範例 1
// Get the Installations service for the default app
var defaultInstallations = admin.installations();
範例 2
// Get the Installations service for a given app
var otherInstallations = admin.installations(otherApp);
instanceId(應用程式)
取得預設應用程式或特定應用程式的 InstanceId 服務。
呼叫 admin.instanceId() 時無需引數即可存取預設應用程式的 InstanceId 服務，也可使用 admin.instanceId(app) 形式呼叫，藉此存取與特定應用程式相關聯的 InstanceId 服務。
簽名：
export declare function instanceId(app?: App): instanceId.InstanceId;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | 應用程式 | 要傳回其 InstanceId 服務的選用應用程式。如未提供，將傳回預設的 InstanceId 服務。 |
傳回：
如未提供應用程式，或是與提供應用程式相關聯的 InstanceId 服務，則預設的 InstanceId 服務。
範例 1
// Get the Instance ID service for the default app
var defaultInstanceId = admin.instanceId();
範例 2
// Get the Instance ID service for a given app
var otherInstanceId = admin.instanceId(otherApp);
MachineLearning(應用程式)
取得預設應用程式或特定應用程式的 MachineLearning 服務。
呼叫 admin.machineLearning() 時無需引數即可存取預設應用程式的 MachineLearning 服務，也可使用 admin.machineLearning(app) 形式呼叫，藉此存取與特定應用程式相關聯的 MachineLearning 服務。
簽名：
export declare function machineLearning(app?: App): machineLearning.MachineLearning;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | 應用程式 | 要傳回其 MachineLearning 服務的選用應用程式。如未提供，將傳回預設的 MachineLearning 服務。 |
傳回：
machineLearning.MachineLearning
如未提供應用程式，或是與提供應用程式相關聯的 MachineLearning 服務，則預設的 MachineLearning 服務。
範例 1
// Get the MachineLearning service for the default app
var defaultMachineLearning = admin.machineLearning();
範例 2
// Get the MachineLearning service for a given app
var otherMachineLearning = admin.machineLearning(otherApp);
訊息(應用程式)
取得預設應用程式或特定應用程式的訊息服務。
呼叫 admin.messaging() 時無需引數即可存取預設應用程式的 Messaging 服務，也可使用 admin.messaging(app) 形式呼叫，藉此存取與特定應用程式相關聯的 Messaging 服務。
簽名：
export declare function messaging(app?: App): messaging.Messaging;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | 應用程式 | 要傳回其 Messaging 服務的選用應用程式。如未提供，將傳回預設的 Messaging 服務。 |
傳回：
如未提供應用程式，或是與提供應用程式相關聯的 Messaging 服務，則預設的 Messaging 服務。
範例 1
// Get the Messaging service for the default app
var defaultMessaging = admin.messaging();
範例 2
// Get the Messaging service for a given app
var otherMessaging = admin.messaging(otherApp);
projectManagement(應用程式)
取得預設應用程式或特定應用程式的 ProjectManagement 服務。
呼叫 admin.projectManagement() 時無需引數即可存取預設應用程式的 ProjectManagement 服務，也可使用 admin.projectManagement(app) 的形式呼叫，存取與特定應用程式相關聯的 ProjectManagement 服務。
簽名：
export declare function projectManagement(app?: App): projectManagement.ProjectManagement;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | 應用程式 | 要傳回其 ProjectManagement 服務的選用應用程式。如未提供，將傳回預設的 ProjectManagement 服務。* |
傳回：
projectManagement.ProjectManagement
如未提供應用程式，或是與提供應用程式相關聯的 ProjectManagement 服務，則預設的 ProjectManagement 服務。
範例 1
// Get the ProjectManagement service for the default app
var defaultProjectManagement = admin.projectManagement();
範例 2
// Get the ProjectManagement service for a given app
var otherProjectManagement = admin.projectManagement(otherApp);
RemoteConfig(應用程式)
取得預設應用程式或特定應用程式的 RemoteConfig 服務。
呼叫 admin.remoteConfig() 時無需引數即可存取預設應用程式的 RemoteConfig 服務，也可使用 admin.remoteConfig(app) 形式呼叫，藉此存取與特定應用程式相關聯的 RemoteConfig 服務。
簽名：
export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | 應用程式 | 用於傳回 RemoteConfig 服務的選用應用程式。如未提供，系統會傳回預設的 RemoteConfig 服務。 |
傳回：
如未提供應用程式，或與提供應用程式相關聯的 RemoteConfig 服務，則預設的 RemoteConfig 服務。
範例 1
// Get the `RemoteConfig` service for the default app
var defaultRemoteConfig = admin.remoteConfig();
範例 2
// Get the `RemoteConfig` service for a given app
var otherRemoteConfig = admin.remoteConfig(otherApp);
SecurityRules(應用程式)
取得預設應用程式或特定應用程式的 SecurityRules 服務。
呼叫 admin.securityRules() 時無需引數，即可存取預設應用程式的 SecurityRules 服務，也可使用 admin.securityRules(app) 呼叫特定應用程式，來存取與此應用程式相關聯的 SecurityRules 服務。
簽名：
export declare function securityRules(app?: App): securityRules.SecurityRules;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | 應用程式 | 用來傳回 SecurityRules 服務的選用應用程式。如未提供，系統會傳回預設的 SecurityRules 服務。 |
傳回：
如未提供應用程式，或與提供應用程式相關聯的 SecurityRules 服務，則預設的 SecurityRules 服務。
範例 1
// Get the SecurityRules service for the default app
var defaultSecurityRules = admin.securityRules();
範例 2
// Get the SecurityRules service for a given app
var otherSecurityRules = admin.securityRules(otherApp);
儲存空間(應用程式)
取得預設應用程式或特定應用程式的 Storage 服務。
呼叫 admin.storage() 時無需引數即可存取預設應用程式的 Storage 服務，也可使用 admin.storage(app) 形式呼叫，藉此存取與特定應用程式相關聯的 Storage 服務。
簽名：
export declare function storage(app?: App): storage.Storage;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | 應用程式 |
傳回：
範例 1
// Get the Storage service for the default app
var defaultStorage = admin.storage();
範例 2
// Get the Storage service for a given app
var otherStorage = admin.storage(otherApp);
應用程式
簽名：
apps: (app.App | null)[]
SDK 版本
簽名：
SDK_VERSION: string