Firebase RemoteConfig
服务接口。
签名:
export declare class RemoteConfig
属性
属性 | 修饰符 | 类型 | 说明 |
---|---|---|---|
应用 | 应用 |
方法
方法 | 修饰符 | 说明 |
---|---|---|
createTemplateFromJSON(json) | 根据 JSON 字符串创建并返回新的 Remote Config 模板。 | |
getServerTemplate(options) | 实例化 ServerTemplate,然后提取并缓存项目的最新模板版本。 | |
getTemplate() | 获取项目的 RemoteConfigTemplate 的当前活跃版本。 | |
getTemplateAtVersion(versionNumber) | 获取所请求的项目的 RemoteConfigTemplate 版本。 | |
initServerTemplate(options) | 同步实例化 ServerTemplate。 | |
listVersions(options) | 获取已发布的 Remote Config 模板版本列表,按时间逆序排列。系统只会存储最近的 300 个版本。与非活跃 Remote Config 模板对应的所有版本(即除客户端提取的模板之外的所有版本)如果保留时间超过 90 天,也会被删除。 | |
publishTemplate(template, options) | 发布 Remote Config 模板。 | |
rollback(versionNumber) | 将项目已发布的 Remote Config 模板回滚到指定版本。回滚相当于获取之前发布的 Remote Config 模板,然后使用强制更新重新发布该模板。 | |
validateTemplate(template) | 验证 RemoteConfigTemplate。 |
RemoteConfig 应用
签名:
readonly app: App;
RemoteConfig.createTemplateFromJSON()
根据 JSON 字符串创建并返回新的 Remote Config 模板。
签名:
createTemplateFromJSON(json: string): RemoteConfigTemplate;
参数
参数 | 类型 | 说明 |
---|---|---|
json | 字符串 | 用于填充 Remote Config 模板的 JSON 字符串。 |
返回:
新的模板实例。
RemoteConfig.getServerTemplate()
实例化 ServerTemplate,然后提取并缓存项目的最新模板版本。
签名:
getServerTemplate(options?: GetServerTemplateOptions): Promise<ServerTemplate>;
参数
参数 | 类型 | 说明 |
---|---|---|
选项 | GetServerTemplateOptions |
返回:
RemoteConfig.getTemplate()
获取项目的 RemoteConfigTemplate 的当前活跃版本。
签名:
getTemplate(): Promise<RemoteConfigTemplate>;
返回:
执行时返回 RemoteConfigTemplate
的 promise。
RemoteConfig.getTemplateAtVersion()
获取所请求的项目的 RemoteConfigTemplate 版本。
签名:
getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;
参数
参数 | 类型 | 说明 |
---|---|---|
versionNumber | 数字 |字符串 | 要查找的 Remote Config 模板的版本号。 |
返回:
执行时返回 RemoteConfigTemplate
的 promise。
RemoteConfig.initServerTemplate()
同步实例化 ServerTemplate。
签名:
initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;
参数
参数 | 类型 | 说明 |
---|---|---|
选项 | InitServerTemplateOptions |
返回:
RemoteConfig.listVersions()
获取已发布的 Remote Config 模板版本列表,按时间逆序排列。系统只会存储最近的 300 个版本。与非活跃 Remote Config 模板对应的所有版本(即除客户端提取的模板之外的所有版本)如果保留时间超过 90 天,也会被删除。
签名:
listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;
参数
参数 | 类型 | 说明 |
---|---|---|
选项 | ListVersionsOptions | 用于获取版本列表的可选选项对象。 |
返回:
Promise<ListVersionsResult>
执行时返回 ListVersionsResult
的 promise。
RemoteConfig.publishTemplate()
发布 Remote Config 模板。
签名:
publishTemplate(template: RemoteConfigTemplate, options?: {
force: boolean;
}): Promise<RemoteConfigTemplate>;
参数
参数 | 类型 | 说明 |
---|---|---|
模板 | RemoteConfigTemplate | 要发布的 Remote Config 模板。 |
选项 | { force: 布尔值;} | 发布 Remote Config 模板时的可选选项对象:- force :将此设置为 true 会强制更新 Remote Config 模板并规避 ETag。不建议使用此方法,因为如果有多个客户端正在更新 Remote Config 模板,此方法可能会导致对 Remote Config 模板的更新丢失。请参阅 ETag 用法和强制更新。 |
返回:
使用已发布的 RemoteConfigTemplate
执行的 Promise。
RemoteConfig.rollback()
将项目已发布的 Remote Config 模板回滚到指定版本。回滚相当于获取之前发布的 Remote Config 模板,然后使用强制更新重新发布该模板。
签名:
rollback(versionNumber: number | string): Promise<RemoteConfigTemplate>;
参数
参数 | 类型 | 说明 |
---|---|---|
versionNumber | 数字 |字符串 | 要回滚到的 Remote Config 模板的版本号。指定的版本号必须低于当前版本号,并且没有因过时而被删除。系统只会存储最近的 300 个版本。与非活跃 Remote Config 模板对应的所有版本(即除客户端提取的模板之外的所有版本)如果已存在超过 90 天,也会被删除。 |
返回:
一个使用已发布的 RemoteConfigTemplate
执行的 promise。
RemoteConfig.validateTemplate()
签名:
validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;
参数
参数 | 类型 | 说明 |
---|---|---|
模板 | RemoteConfigTemplate | 要验证的 Remote Config 模板。 |
返回:
使用经过验证的 RemoteConfigTemplate
执行的 promise。