Firebase RemoteConfig 服務介面。
簽名：
export declare class RemoteConfig
屬性
| 屬性 | 修飾符 | 類型 | 說明 |
|---|---|---|---|
| 應用程式 | 應用程式 |
方法
| 方式 | 修飾符 | 說明 |
|---|---|---|
| createTemplateFromJSON(json) | 以 JSON 字串建立並傳回新的遠端設定範本。 | |
| getServerTemplate(選項) | 將 ServerTemplate 例項化，然後擷取及快取專案的最新範本版本。 | |
| getTemplate() | 取得專案目前的有效版本 RemoteConfigTemplate。 | |
| getTemplateAtVersion(versionNumber) | 取得專案的 RemoteConfigTemplate 要求版本。 | |
| initServerTemplate(options) | 同步將 ServerTemplate 執行個體化。 | |
| listVersions(options) | 取得已發布的遠端設定範本版本清單，按時間順序由新至舊排序。系統只會儲存最後 300 個版本。如果對應版本為非有效遠端設定範本 (即用戶端擷取的範本除外) 的所有版本存在超過 90 天，系統也會刪除這些版本。 | |
| publishTemplate(範本, 選項) | 發布遠端設定範本。 | |
| 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>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 選項 | ListVersionsOptions | 用於取得版本清單的選用選項物件。 |
傳回：
Promise<ListVersionsResult>
憑藉 ListVersionsResult 實現承諾。
RemoteConfig.publishTemplate()
發布遠端設定範本。
簽名：
publishTemplate(template: RemoteConfigTemplate, options?: {
force: boolean;
}): Promise<RemoteConfigTemplate>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 範本 | RemoteConfigTemplate | 要發布的遠端設定範本。 |
| 選項 | { 強制：布林值; } | 發布遠端設定範本時的選用選項物件：- 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 履行承諾。