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';