Firebase 遠端配置 Web SDK。此 SDK 不適用於 Node.js 環境。
功能
功能 | 描述 |
---|---|
函數(應用程序,...) | |
取得遠端配置(應用程式) | |
函數(遠端配置,...) | |
啟動(遠端配置) | 使最後取得的配置可供 getter 使用。 |
確保初始化(remoteConfig) | 確保 getter 可以使用最後啟動的配置。 |
fetchAndActivate(遠端配置) | 為了方便起見,執行獲取和啟動操作。 |
取得配置(遠端配置) | 從遠端配置服務獲取並快取配置。 |
取得全部(遠端配置) | 取得所有配置。 |
getBoolean(remoteConfig, 鍵) | 取得給定鍵的布林值。呼叫remoteConfig.getValue(key).asBoolean() 的便捷方法。 |
getNumber(remoteConfig, 鍵) | 取得給定鍵的數字值。呼叫remoteConfig.getValue(key).asNumber() 的便捷方法。 |
getString(remoteConfig, 鍵) | 取得給定鍵的字串形式的值。呼叫remoteConfig.getValue(key).asString() 的便捷方法。 |
getValue(remoteConfig, 鍵) | 取得給定鍵的值。 |
setLogLevel(remoteConfig, logLevel) | 定義要使用的日誌等級。 |
功能() | |
isSupported() | 此方法提供兩種不同的檢查: 1.檢查瀏覽器環境中是否存在IndexedDB。 2. 檢查目前瀏覽器上下文是否允許 IndexedDB open() 呼叫。 |
介面
介面 | 描述 |
---|---|
遠端配置 | Firebase 遠端配置服務介面。 |
遠端配置設定 | 定義遠端配置 SDK 的配置選項。 |
價值 | 用元資料和型別安全的 getter 包裝一個值。 |
類型別名
類型別名 | 描述 |
---|---|
獲取狀態 | 總結上次嘗試從 Firebase 遠端設定伺服器取得配置的結果。
|
日誌等級 | 定義遠端配置日誌記錄的等級。 |
價值源 | 指示值的來源。
|
函數(應用程序,...)
取得遠端配置(應用程式)
簽名:
export declare function getRemoteConfig(app?: FirebaseApp): RemoteConfig;
參數
範圍 | 類型 | 描述 |
---|---|---|
應用程式 | Firebase應用程式 | FirebaseApp實例。 |
返回:
一個RemoteConfig實例。
函數(遠端配置,...)
啟動(遠端配置)
使最後取得的配置可供 getter 使用。
簽名:
export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;
參數
範圍 | 類型 | 描述 |
---|---|---|
遠端配置 | 遠端配置 | RemoteConfig實例。 |
返回:
承諾<布林值>
如果目前呼叫啟動了取得的配置,則Promise
解析為 true。如果取得的配置已被激活,則Promise
將解析為 false。
確保初始化(remoteConfig)
確保 getter 可以使用最後啟動的配置。
簽名:
export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;
參數
範圍 | 類型 | 描述 |
---|---|---|
遠端配置 | 遠端配置 | RemoteConfig實例。 |
返回:
承諾<無效>
當最後啟動的配置可供 getter 使用時解析的Promise
。
fetchAndActivate(遠端配置)
為了方便起見,執行獲取和啟動操作。
簽名:
export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;
參數
範圍 | 類型 | 描述 |
---|---|---|
遠端配置 | 遠端配置 | RemoteConfig實例。 |
返回:
承諾<布林值>
如果目前呼叫啟動了取得的配置,則Promise
解析為 true。如果取得的配置已被激活,則Promise
將解析為 false。
取得配置(遠端配置)
從遠端配置服務獲取並快取配置。
簽名:
export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;
參數
範圍 | 類型 | 描述 |
---|---|---|
遠端配置 | 遠端配置 | RemoteConfig實例。 |
返回:
承諾<無效>
取得全部(遠端配置)
取得所有配置。
簽名:
export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;
參數
範圍 | 類型 | 描述 |
---|---|---|
遠端配置 | 遠端配置 | RemoteConfig實例。 |
返回:
記錄<字串,值>
所有配置。
getBoolean(remoteConfig, 鍵)
取得給定鍵的布林值。
呼叫remoteConfig.getValue(key).asBoolean()
的便捷方法。
簽名:
export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;
參數
範圍 | 類型 | 描述 |
---|---|---|
遠端配置 | 遠端配置 | RemoteConfig實例。 |
鑰匙 | 細繩 | 參數的名稱。 |
返回:
布林值
給定鍵的布林值。
getNumber(remoteConfig, 鍵)
取得給定鍵的數字值。
呼叫remoteConfig.getValue(key).asNumber()
的便捷方法。
簽名:
export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;
參數
範圍 | 類型 | 描述 |
---|---|---|
遠端配置 | 遠端配置 | RemoteConfig實例。 |
鑰匙 | 細繩 | 參數的名稱。 |
返回:
數位
給定鍵的值作為數字。
getString(remoteConfig, 鍵)
取得給定鍵的字串形式的值。呼叫remoteConfig.getValue(key).asString()
的便捷方法。
簽名:
export declare function getString(remoteConfig: RemoteConfig, key: string): string;
參數
範圍 | 類型 | 描述 |
---|---|---|
遠端配置 | 遠端配置 | RemoteConfig實例。 |
鑰匙 | 細繩 | 參數的名稱。 |
返回:
細繩
給定鍵的值作為字串。
getValue(remoteConfig, 鍵)
取得給定鍵的值。
簽名:
export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;
參數
範圍 | 類型 | 描述 |
---|---|---|
遠端配置 | 遠端配置 | RemoteConfig實例。 |
鑰匙 | 細繩 | 參數的名稱。 |
返回:
給定鍵的值。
setLogLevel(remoteConfig, logLevel)
定義要使用的日誌等級。
簽名:
export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;
參數
範圍 | 類型 | 描述 |
---|---|---|
遠端配置 | 遠端配置 | RemoteConfig實例。 |
日誌等級 | 遠端配置日誌等級 | 要設定的日誌等級。 |
返回:
空白
功能()
isSupported()
此方法提供兩種不同的檢查:
- 檢查瀏覽器環境中是否存在IndexedDB。 2. 檢查目前瀏覽器上下文是否允許 IndexedDB
open()
呼叫。
簽名:
export declare function isSupported(): Promise<boolean>;
返回:
承諾<布林值>
如果可以在此環境中初始化RemoteConfig實例,則Promise
解析為 true;如果不能,則解析為 false。
獲取狀態
總結上次嘗試從 Firebase 遠端設定伺服器取得配置的結果。
- 「no-fetch-yet」表示 [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) 實例尚未嘗試取得配置,或 SDK 初始化不完整。
- 「success」表示最後一次嘗試成功。
- 「失敗」表示最後一次嘗試失敗。
- 「throttle」表示最後一次嘗試受到速率限制。
簽名:
export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';
日誌等級
定義遠端配置日誌記錄的等級。
簽名:
export declare type LogLevel = 'debug' | 'error' | 'silent';
價值源
指示值的來源。
- 「static」表示該值是由靜態常數定義的。
- “default”表示該值是由預設配置定義的。
- “remote”表示該值是由獲取的配置定義的。
簽名:
export declare type ValueSource = 'static' | 'default' | 'remote';