RemoteConfigParameter interface
Stay organized with collections
Save and categorize content based on your preferences.
Interface representing a Remote Config parameter. At minimum, a defaultValue or a conditionalValues entry must be present for the parameter to have any effect.
Signature:
export interface RemoteConfigParameter
Properties
| Property |
Type |
Description |
| conditionalValues |
{ [key: string]: RemoteConfigParameterValue; } |
A (condition name, value) map. The condition name of the highest priority (the one listed first in the Remote Config template's conditions list) determines the value of this parameter. |
| defaultValue |
RemoteConfigParameterValue |
The value to set the parameter to, when none of the named conditions evaluate to true. |
| description |
string |
A description for this parameter. Should not be over 100 characters and may contain any Unicode characters. |
| valueType |
ParameterValueType |
The data type for all values of this parameter in the current version of the template. Defaults to ParameterValueType.STRING if unspecified. |
RemoteConfigParameter.conditionalValues
A (condition name, value) map. The condition name of the highest priority (the one listed first in the Remote Config template's conditions list) determines the value of this parameter.
Signature:
conditionalValues?: {
[key: string]: RemoteConfigParameterValue;
};
RemoteConfigParameter.defaultValue
The value to set the parameter to, when none of the named conditions evaluate to true.
Signature:
defaultValue?: RemoteConfigParameterValue;
RemoteConfigParameter.description
A description for this parameter. Should not be over 100 characters and may contain any Unicode characters.
Signature:
description?: string;
RemoteConfigParameter.valueType
The data type for all values of this parameter in the current version of the template. Defaults to ParameterValueType.STRING if unspecified.
Signature:
valueType?: ParameterValueType;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-29 UTC.
[null,null,["Last updated 2022-07-29 UTC."],[],[],null,["# RemoteConfigParameter interface\n\nInterface representing a Remote Config parameter. At minimum, a `defaultValue` or a `conditionalValues` entry must be present for the parameter to have any effect.\n\n**Signature:** \n\n export interface RemoteConfigParameter \n\nProperties\n----------\n\n| Property | Type | Description |\n|---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [conditionalValues](./firebase-admin.remote-config.remoteconfigparameter.md#remoteconfigparameterconditionalvalues) | { \\[key: string\\]: [RemoteConfigParameterValue](./firebase-admin.remote-config.md#remoteconfigparametervalue); } | A `(condition name, value)` map. The condition name of the highest priority (the one listed first in the Remote Config template's conditions list) determines the value of this parameter. |\n| [defaultValue](./firebase-admin.remote-config.remoteconfigparameter.md#remoteconfigparameterdefaultvalue) | [RemoteConfigParameterValue](./firebase-admin.remote-config.md#remoteconfigparametervalue) | The value to set the parameter to, when none of the named conditions evaluate to `true`. |\n| [description](./firebase-admin.remote-config.remoteconfigparameter.md#remoteconfigparameterdescription) | string | A description for this parameter. Should not be over 100 characters and may contain any Unicode characters. |\n| [valueType](./firebase-admin.remote-config.remoteconfigparameter.md#remoteconfigparametervaluetype) | [ParameterValueType](./firebase-admin.remote-config.md#parametervaluetype) | The data type for all values of this parameter in the current version of the template. Defaults to `ParameterValueType.STRING` if unspecified. |\n\nRemoteConfigParameter.conditionalValues\n---------------------------------------\n\nA `(condition name, value)` map. The condition name of the highest priority (the one listed first in the Remote Config template's conditions list) determines the value of this parameter.\n\n**Signature:** \n\n conditionalValues?: {\n [key: string]: RemoteConfigParameterValue;\n };\n\nRemoteConfigParameter.defaultValue\n----------------------------------\n\nThe value to set the parameter to, when none of the named conditions evaluate to `true`.\n\n**Signature:** \n\n defaultValue?: RemoteConfigParameterValue;\n\nRemoteConfigParameter.description\n---------------------------------\n\nA description for this parameter. Should not be over 100 characters and may contain any Unicode characters.\n\n**Signature:** \n\n description?: string;\n\nRemoteConfigParameter.valueType\n-------------------------------\n\nThe data type for all values of this parameter in the current version of the template. Defaults to `ParameterValueType.STRING` if unspecified.\n\n**Signature:** \n\n valueType?: ParameterValueType;"]]
