Firebase Remote Config。
Functions
函数 | 说明 |
---|---|
getRemoteConfig(app) | 获取默认应用或指定应用的 RemoteConfig 服务。可调用getRemoteConfig() (不使用任何参数)来访问默认应用的 RemoteConfig 服务,或者以 getRemoteConfig(app) 的形式调用RemoteConfig 以访问特定应用服务。 |
类
类 | 说明 |
---|---|
RemoteConfig | Firebase RemoteConfig 服务接口。 |
枚举
Enumeration | 说明 |
---|---|
PercentConditionOperator | 定义百分比条件支持的运算符。 |
接口
接口 | 说明 |
---|---|
AndCondition | 表示评估结果为 true 时,如果所有结果均为 true 的一组条件。 |
显式参数值 | 表示显式参数值的接口。 |
GetServerTemplateOptions | 表示在实例化 ServerTemplate 时可以使用的可选参数。 |
InAppDefaultValue | 表示应用内默认值的接口。 |
InitServerTemplateOptions | 表示同步实例化 ServerTemplate 时可以使用的可选参数。 |
ListVersionsOptions | 显示 Remote Config 列表版本操作选项的界面。 |
ListVersionsResult | 表示 Remote Config 模板版本列表的接口。 |
MicroPercentRange | 表示要定位的百分位数限制(以微百分比为单位)。值必须在 [0 到 100000000] 范围内 |
NamedCondition | 表示数据平面中的 Remote Config 条件。条件定位一组特定的用户。这些条件列表构成了 Remote Config 模板的一部分。 |
OneOfCondition | 表示可能属于几种类型之一的条件。系统只会处理第一个定义的字段。 |
OrCondition | 表示评估结果为 true(如果有)的一系列条件。 |
PercentCondition | 表示将实例伪随机百分位与给定限制进行比较的条件。 |
RemoteConfigCondition | 表示 Remote Config 条件的接口。条件定位一组特定的用户。这些条件列表构成了 Remote Config 模板的一部分。 |
RemoteConfigParameter | 表示 Remote Config 参数的接口。为使该参数有效,至少必须存在 defaultValue 或 conditionalValues 条目。 |
RemoteConfigParameterGroup | 表示 Remote Config 参数组的接口。对参数进行分组仅用于管理目的,不会影响参数值的客户端提取。 |
RemoteConfigTemplate | 表示 Remote Config 客户端模板。 |
RemoteConfigUser | 表示 Remote Config 用户的界面。 |
服务器配置 | 表示通过评估服务器模板生成的配置。 |
服务器模板 | 表示 Remote Config 服务器模板的有状态抽象。 |
服务器模板数据 | 表示 Remote Config 服务器模板中的数据。 |
值 | 使用元数据和类型安全的 getter 封装参数值。类型安全的 getter 可以隔离应用逻辑,使其免于对参数名称和类型进行远程更改。 |
版本 | 表示 Remote Config 模板版本的接口。仅输出,但版本说明除外。包含特定 Remote Config 模板版本的元数据。所有字段均在指定的 Remote Config 模板发布时进行设置。您可以在 publishTemplate 调用中指定版本的说明字段。 |
类型别名
类型别名 | 说明 |
---|---|
DefaultConfig | 定义应用内默认参数值的格式。 |
EvaluationContext | 表示模板评估输入信号。 |
参数值类型 | 表示 Remote Config 参数值数据类型的类型。如果未指定,则默认为 STRING 。 |
RemoteConfigParameterValue | 表示 Remote Config 参数值的类型。RemoteConfigParameterValue 可以是 ExplicitParameterValue ,也可以是 InAppDefaultValue 。 |
服务器模板数据类型 | 表示可在 ServerTemplate 上设置的 Remote Config 服务器模板的类型。这可以是 ServerTemplateData 对象,也可以是模板 JSON 字符串。 |
TagColor | 与显示条件相关联的颜色。 |
值来源 | 表示值的来源。
|
getRemoteConfig(应用)
获取默认应用或指定应用的 RemoteConfig 服务。
可以不使用任何参数调用 getRemoteConfig()
,以访问默认应用的 RemoteConfig
服务,或者以 getRemoteConfig(app)
的形式调用,以访问与特定应用相关联的 RemoteConfig
服务。
签名:
export declare function getRemoteConfig(app?: App): RemoteConfig;
参数
参数 | 类型 | 说明 |
---|---|---|
app | 应用 | 可选应用,要为其返回 RemoteConfig 服务。如果未提供,则返回默认的 RemoteConfig 服务。 |
返回:
默认的 RemoteConfig
服务(如果未提供应用),或与提供的应用关联的 RemoteConfig
服务。
示例 1
// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();
示例 2
// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);
默认配置
定义应用内默认参数值的格式。
签名:
export type DefaultConfig = {
[key: string]: string | number | boolean;
};
EvaluationContext
表示模板评估输入信号。
签名:
export type EvaluationContext = {
randomizationId?: string;
};
ParameterValueType
表示 Remote Config 参数值数据类型的类型。如果未指定,则默认为 STRING
。
签名:
export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';
RemoteConfigParameterValue
表示 Remote Config 参数值的类型。RemoteConfigParameterValue
可以是 ExplicitParameterValue
或 InAppDefaultValue
。
签名:
export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;
服务器模板数据类型
表示可在 ServerTemplate 上设置的 Remote Config 服务器模板的类型。这可以是 ServerTemplateData 对象,也可以是模板 JSON 字符串。
签名:
export type ServerTemplateDataType = ServerTemplateData | string;
标记颜色
与显示条件相关联的颜色。
签名:
export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';
价值源
表示值的来源。
- “static”表示值由静态常量定义。
- “default”表示该值是由默认配置定义的。
- “remote”表示值是由通过评估模板生成的配置定义的。
签名:
export type ValueSource = 'static' | 'default' | 'remote';
PercentConditionOperator
定义百分比条件支持的运算符。
签名:
export declare enum PercentConditionOperator
枚举成员
成员 | 值 | 说明 |
---|---|---|
BETWEEN | "BETWEEN" |
由下限和上限定义的间隔内的目标百分位。下限为独占(开放)边界,micro_percent_range_upper_bound 是包含(封闭)边界。使用此运算符的条件必须指定 microPercentRange。 |
GREATER_THAN | "GREATER_THAN" |
高于目标百分比的目标百分位数。使用此运算符的条件必须指定 microPercent。 |
LESS_OR_EQUAL | "LESS_OR_EQUAL" |
小于或等于目标百分比的目标百分位。使用此运算符的条件必须指定 microPercent。 |
未知 | "UNKNOWN" |
无限别名错误情况。 |