Firebase RemoteConfig 服務介面。
簽名：
export declare class RemoteConfig
屬性
| 屬性 | 修飾符 | 類型 | 說明 |
|---|---|---|---|
| 應用程式 | 應用程式 |
方法
| 方法 | 修飾符 | 說明 |
|---|---|---|
| createTemplateFromJSON(json) | 透過 JSON 字串建立並傳回新的遠端設定範本。 | |
| getServerTemplate(選項) | 將 ServerTemplate 執行個體化，然後擷取並快取最新的專案範本版本。 | |
| getTemplate() | 取得專案 RemoteConfigTemplate 目前使用中的版本。 | |
| getTemplateAtVersion(versionNumber) | 取得專案的 RemoteConfigTemplate 要求版本。 | |
| initServerTemplate(選項) | 同步將 ServerTemplate 執行個體化。 | |
| listVersions(選項) | 取得已發布的遠端設定範本版本清單，並按時間順序由新至舊排序。系統只會儲存最近 300 個版本。凡是對應至非使用中遠端設定範本的版本 (即用戶端擷取的範本除外)，只要版本建立於超過 90 天，都會一併遭到刪除。 | |
| publishTemplate(template, options) | 發布遠端設定範本。 | |
| rollback(versionNumber) | 將專案的已發布遠端設定範本復原至指定版本。復原等同於取得先前發布的遠端設定範本，然後使用強制更新重新發布範本。 | |
| validateTemplate(範本) | 驗證 RemoteConfigTemplate。 |
RemoteConfig.app
簽名：
readonly app: App;
RemoteConfig.createTemplateFromJSON()
透過 JSON 字串建立並傳回新的遠端設定範本。
簽名：
createTemplateFromJSON(json: string): RemoteConfigTemplate;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| json | 字串 | 要填入遠端設定範本的 JSON 字串。 |
傳回：
新的範本執行個體。
RemoteConfig.getServerTemplate()
將 ServerTemplate 執行個體化，然後擷取並快取最新的專案範本版本。
簽名：
getServerTemplate(options?: GetServerTemplateOptions): Promise<ServerTemplate>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 選項 | GetServerTemplateOptions |
傳回：
Promise<ServerTemplate>
RemoteConfig.getTemplate()
取得專案 RemoteConfigTemplate 目前使用中的版本。
簽名：
getTemplate(): Promise<RemoteConfigTemplate>;
傳回：
Promise<RemoteConfigTemplate>
利用 RemoteConfigTemplate 實現的承諾。
RemoteConfig.getTemplateAtVersion()
取得專案的 RemoteConfigTemplate 要求版本。
簽名：
getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 版本號碼 | 數字 |字串 | 要查詢的遠端設定範本版本號碼。 |
傳回：
Promise<RemoteConfigTemplate>
利用 RemoteConfigTemplate 實現的承諾。
RemoteConfig.initServerTemplate()
同步將 ServerTemplate 執行個體化。
簽名：
initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 選項 | InitServerTemplateOptions |
傳回：
RemoteConfig.listVersions()
取得已發布的遠端設定範本版本清單，並按時間順序由新至舊排序。系統只會儲存最近 300 個版本。凡是對應至非使用中遠端設定範本的版本 (即用戶端擷取的範本除外)，只要版本建立於超過 90 天，都會一併遭到刪除。
簽名：
listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 選項 | ListVersions 選項 | 用於取得版本清單的選用選項物件。 |
傳回：
Promise<ListVersionsResult>
利用 ListVersionsResult 實現的承諾。
RemoteConfig.publishTemplate()
發布遠端設定範本。
簽名：
publishTemplate(template: RemoteConfigTemplate, options?: {
force: boolean;
}): Promise<RemoteConfigTemplate>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 範本 | RemoteConfigTemplate | 要發布的遠端設定範本。 |
| 選項 | { force: boolean;} | 發布遠端設定範本時的選用選項物件：- force：如將這個值設為 true，系統就會強制更新及規避 ETag。我們不建議採用這種做法，因為如果多個用戶端更新遠端設定範本，遠端設定範本可能會遺失更新。請參閱「ETag 使用情形與強制更新」一節。 |
傳回：
Promise<RemoteConfigTemplate>
用已發布的 RemoteConfigTemplate 實現的承諾。
RemoteConfig.rollback()
將專案的已發布遠端設定範本復原至指定版本。復原等同於取得先前發布的遠端設定範本，然後使用強制更新重新發布範本。
簽名：
rollback(versionNumber: number | string): Promise<RemoteConfigTemplate>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 版本號碼 | 數字 |字串 | 要復原的遠端設定範本版本號碼。指定的版本號碼必須低於目前的版本號碼，且因過時程度而未刪除。系統只會儲存最近 300 個版本。凡是對應至非使用中遠端設定範本的版本 (也就是說，除了用戶端擷取的範本外的所有版本)，且已建立超過 90 天，系統也會刪除這些版本。 |
傳回：
Promise<RemoteConfigTemplate>
能履行已發布的 RemoteConfigTemplate 的承諾。
RemoteConfig.validateTemplate()
簽名：
validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 範本 | RemoteConfigTemplate | 要驗證的遠端設定範本。 |
傳回：
Promise<RemoteConfigTemplate>
保證能履行驗證的 RemoteConfigTemplate。