Firebase Remote Config.
Funciones
Función | Descripción |
---|---|
getRemoteConfig(app) | Obtiene el servicio RemoteConfig para la app predeterminada o una app determinada.Se puede llamar a getRemoteConfig() sin argumentos para acceder al servicio RemoteConfig de la app predeterminada o como getRemoteConfig(app) para acceder al servicio RemoteConfig asociado con una app específica. |
Clases
Clase | Descripción |
---|---|
RemoteConfig | La interfaz de servicio RemoteConfig de Firebase. |
Enumeraciones
Enumeration | Descripción |
---|---|
PercentConditionOperator | Define los operadores admitidos para las condiciones porcentuales. |
Interfaces
Interfaz | Descripción |
---|---|
AndCondition | Representa una colección de condiciones que se evalúan como verdaderas si todas son verdaderas. |
ExplainParameterValue | Interfaz que representa un valor de parámetro explícito. |
GetServerTemplateOptions. | Representa argumentos opcionales que se pueden usar cuando se crea una instancia de ServerTemplate. |
InAppDefaultValue | Interfaz que representa un valor predeterminado en la app |
InitServerTemplateOptions | Representa argumentos opcionales que se pueden usar cuando se crea una instancia de ServerTemplate de forma síncrona. |
Opciones de listas de versiones | Interfaz que representa opciones para la operación de versiones de lista de Remote Config. |
ListVersionsResult | Interfaz que representa una lista de versiones de plantillas de Remote Config. |
MicroPercentRange | Representa el límite de percentiles al objetivo en microporcentajes. El valor debe estar entre 0 y 1,000,000,000 |
NamedCondition | Representa una condición de Remote Config en el plano de datos. Una condición se orienta a un grupo específico de usuarios. Una lista de estas condiciones comprende parte de una plantilla de Remote Config. |
OneOfCondition | Representa una condición que puede ser de varios tipos. Solo se procesará el primer campo definido. |
OrCondition | Representa una colección de condiciones que se evalúan como verdaderas, si alguna es verdadera. |
PercentCondition | Representa una condición que compara el percentil pseudoaleatorio de la instancia con un límite determinado. |
RemoteConfigCondition. | Interfaz que representa una condición de Remote Config. Una condición se orienta a un grupo específico de usuarios. Una lista de estas condiciones forma parte de una plantilla de Remote Config. |
RemoteConfigParameter | Interfaz que representa un parámetro de Remote Config. Como mínimo, debe haber una entrada defaultValue o conditionalValues para que el parámetro tenga efecto. |
RemoteConfigParameterGroup | Interfaz que representa un grupo de parámetros de Remote Config. La agrupación de parámetros es solo con fines de administración y no afecta la recuperación de valores de parámetros del cliente. |
RemoteConfigTemplate | Representa una plantilla de cliente de Remote Config. |
RemoteConfigUser | Interfaz que representa un usuario de Remote Config. |
ServerConfig | Representa la configuración que se produce cuando se evalúa una plantilla de servidor. |
ServerTemplate | Representa una abstracción con estado para una plantilla de servidor de Remote Config. |
ServerTemplateData | Representa los datos en una plantilla del servidor de Remote Config. |
Valor | Une un valor de parámetro con metadatos y métodos get de tipo seguro.Los métodos get de tipo seguro aíslan la lógica de la aplicación de los cambios remotos a los nombres y tipos de parámetros. |
Versión | Interfaz que representa la versión de una plantilla de Remote Config. Solo salida, excepto la descripción de la versión. Contiene metadatos sobre una versión específica de la plantilla de Remote Config. Todos los campos se configuran en el momento en que se publica la plantilla de Remote Config especificada. El campo de descripción de una versión se puede especificar en las llamadas publishTemplate . |
Escribe alias
Alias de tipo | Descripción |
---|---|
Configuración predeterminada | Define el formato para los valores de parámetros predeterminados en la app. |
EvaluaciónContext | Representa indicadores de entrada de evaluación de plantillas. |
ParameterValueType | Es un tipo que representa un tipo de datos del valor del parámetro de Remote Config. Si no se especifica, el número predeterminado es STRING . |
RemoteConfigParameterValue | Tipo que representa un valor de parámetro de Remote Config. Un RemoteConfigParameterValue puede ser un ExplicitParameterValue o un InAppDefaultValue . |
ServerTemplateDataType | Representa el tipo de una plantilla de servidor de Remote Config que se puede configurar en ServerTemplate. Puede ser un objeto ServerTemplateData o una string JSON de plantilla. |
ColorColor | Son los colores asociados con las condiciones con fines de visualización. |
ValueSource | Indica la fuente de un valor.
|
getRemoteConfig(app)
Obtiene el servicio de RemoteConfig para la app predeterminada o una app determinada.
Se puede llamar a getRemoteConfig()
sin argumentos para acceder al servicio RemoteConfig
de la app predeterminada o como getRemoteConfig(app)
para acceder al servicio RemoteConfig
asociado con una app específica.
Firma:
export declare function getRemoteConfig(app?: App): RemoteConfig;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
app | App | App opcional para la que se muestra el servicio RemoteConfig Si no se proporciona, se muestra el servicio RemoteConfig predeterminado. |
Devuelve:
El servicio predeterminado RemoteConfig
si no se proporciona ninguna app, o bien el servicio RemoteConfig
asociado con la app proporcionada.
Ejemplo 1
// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();
Ejemplo 2
// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);
Configuración predeterminada
Define el formato para los valores de parámetros predeterminados en la app.
Firma:
export type DefaultConfig = {
[key: string]: string | number | boolean;
};
EvaluaciónContext
Representa indicadores de entrada de evaluación de plantillas.
Firma:
export type EvaluationContext = {
randomizationId?: string;
};
ParameterValueType
Es un tipo que representa un tipo de datos del valor del parámetro de Remote Config. Si no se especifica, el número predeterminado es STRING
.
Firma:
export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';
RemoteConfigParameterValue
Tipo que representa un valor de parámetro de Remote Config. Un RemoteConfigParameterValue
puede ser un ExplicitParameterValue
o un de InAppDefaultValue
.
Firma:
export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;
TipodeDatosdePlantilladeServidor
Representa el tipo de una plantilla de servidor de Remote Config que se puede configurar en ServerTemplate. Puede ser un objeto ServerTemplateData o una string JSON de plantilla.
Firma:
export type ServerTemplateDataType = ServerTemplateData | string;
Color TagColor
Son los colores asociados con las condiciones con fines de visualización.
Firma:
export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';
Fuente del valor
Indica la fuente de un valor.
- "estático" indica que el valor se definió por una constante estática.
- “default” indica que el valor se definió mediante la configuración predeterminada.
- “remote” indica que la configuración producida mediante la evaluación de una plantilla definió el valor.
Firma:
export type ValueSource = 'static' | 'default' | 'remote';
PercentConditionOperator
Define los operadores admitidos para las condiciones porcentuales.
Firma:
export declare enum PercentConditionOperator
Miembros de enumeración
Miembro | Valor | Descripción |
---|---|---|
BETWEEN | "BETWEEN" |
Percentiles de destino dentro de un intervalo definido por un límite inferior y un límite superior. El límite inferior es un límite exclusivo (abierto), y el micro_percent_range_upper_bound es un límite inclusivo (cerrado). Una condición que use este operador debe especificar microPercentRange. |
GREATER_THAN | "GREATER_THAN" |
Percentiles objetivo mayores que el porcentaje objetivo. Una condición que use este operador debe especificar microPercent. |
MENOS_O_EQUAL | "LESS_OR_EQUAL" |
Percentiles objetivo inferiores o iguales al porcentaje objetivo. Una condición que use este operador debe especificar microPercent. |
DESCONOCIDO | "UNKNOWN" |
Un caso de error genérico. |