Firebase 遠端設定。
函式
函式 | 說明 |
---|---|
getRemoteConfig(應用程式) | 取得預設應用程式或特定應用程式的 RemoteConfig 服務。無需引數即可呼叫 getRemoteConfig() ,藉此存取預設應用程式的 RemoteConfig 服務,也可以做為 getRemoteConfig(app) 來存取與特定應用程式相關聯的 RemoteConfig 服務。 |
等級
類別 | 說明 |
---|---|
RemoteConfig | Firebase RemoteConfig 服務介面。 |
列舉
Enumeration | 說明 |
---|---|
PercentCondition 運算子 | 定義支援的百分比條件的運算子。 |
介面
介面 | 說明 |
---|---|
AndCondition | 代表一組條件,如果所有條件皆為 true,則評估為 true。 |
明確參數值 | 代表明確參數值的介面。 |
GetServerTemplateOptions | 代表可用於執行個體化 ServerTemplate 的選用引數。 |
InAppDefaultValue | 代表應用程式內預設值的介面。 |
InitServerTemplateOptions | 代表同步 ServerTemplate 例項化時可用的選用引數。 |
ListVersionsOptions | 代表遠端設定清單版本作業選項的介面。 |
ListVersionsResult | 代表遠端設定範本版本清單的介面。 |
微百分比範圍 | 代表要指定的百分位數上限,以微百分比為單位。這個值必須介於 [0 到 100000000] 之間 |
NamedCondition | 代表資料層中的遠端設定條件。條件可指定特定一群使用者。這些條件清單包含遠端設定範本的一部分。 |
OneOfCondition | 代表條件可以是多種類型之一。系統只會處理第一個定義的欄位。 |
OrCondition | 代表一組條件,如果條件為 true,則評估為 true。 |
PercentCondition | 代表將執行個體虛擬隨機百分位數與指定限制進行比較的條件。 |
RemoteConfigCondition | 代表遠端設定條件的介面。條件可指定特定一群使用者。這些條件的清單組成遠端設定範本。 |
RemoteConfigParameter | 代表遠端設定參數的介面。至少須有 defaultValue 或 conditionalValues 項目,參數才會生效。 |
RemoteConfigParameterGroup | 代表遠端設定參數群組的介面。分組參數僅用於管理,不會影響用戶端擷取參數值。 |
RemoteConfigTemplate | 代表遠端設定用戶端範本。 |
RemoteConfigUser | 代表遠端設定使用者的介面。 |
ServerConfig | 代表評估伺服器範本時產生的設定。 |
ServerTemplate | 代表遠端設定伺服器範本的有狀態抽象化機制。 |
ServerTemplateData | 代表遠端設定伺服器範本中的資料。 |
值 | 使用中繼資料和類型安全 getter 包裝參數值。型別安全 getter 會將應用程式邏輯,從遠端變更為參數名稱和類型。 |
版本 | 代表遠端設定範本版本的介面。僅供輸出,版本說明除外。包含特定遠端設定範本版本的中繼資料。所有欄位會在指定的遠端設定範本發布時設定。版本的說明欄位可以在 publishTemplate 呼叫中指定。 |
類型別名
類型別名 | 說明 |
---|---|
DefaultConfig | 定義應用程式內預設參數值的格式。 |
EvaluationContext | 代表範本評估輸入信號。 |
ParameterValueType | 代表遠端設定參數值資料類型的類型。如未指定,預設值為 STRING 。 |
RemoteConfigParameterValue | 代表遠端設定參數值的類型。RemoteConfigParameterValue 可以是 ExplicitParameterValue 或 InAppDefaultValue 。 |
ServerTemplateDataType | 代表可在 ServerTemplate 上設定的遠端設定伺服器範本類型。這可以是 ServerTemplateData 物件或範本 JSON 字串。 |
標記顏色 | 為顯示目的相關聯的顏色, |
價值來源 | 表示值的來源。
|
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;
};
評估情境
代表範本評估輸入信號。
簽名:
export type EvaluationContext = {
randomizationId?: string;
};
ParameterValueType
代表遠端設定參數值資料類型的類型。如未指定,預設值為 STRING
。
簽名:
export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';
遠端設定參數值
代表遠端設定參數值的類型。RemoteConfigParameterValue
可以是 ExplicitParameterValue
或 InAppDefaultValue
。
簽名:
export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;
ServerTemplateDataType
代表可在 ServerTemplate 上設定的遠端設定伺服器範本類型。這可以是 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';
PercentCondition 運算子
定義支援的百分比條件的運算子。
簽名:
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" |
全部接收的錯誤。 |