firebase-admin.remote-config package

Configuración remota de Firebase.

Funciones

Función	Descripción
getRemoteConfig(aplicación)	Obtiene el servicio RemoteConfig para la aplicación predeterminada o una aplicación determinada. Se puede llamar getRemoteConfig() sin argumentos para acceder al servicio RemoteConfig de la aplicación predeterminada o como getRemoteConfig(app) para acceder al servicio RemoteConfig asociado con una aplicación específica.

Clases

Clase	Descripción
Configuración remota	La interfaz del servicio Firebase RemoteConfig .

Interfaces

Interfaz	Descripción
Valor de parámetro explícito	Interfaz que representa un valor de parámetro explícito.
Valor predeterminado en la aplicación	Interfaz que representa un valor predeterminado en la aplicación.
Opciones de versiones de lista	Interfaz que representa opciones para el funcionamiento de las versiones de la lista de Remote Config.
ListaVersionesResultado	Interfaz que representa una lista de versiones de plantillas de Remote Config.
Condición de configuración remota	Interfaz que representa una condición de Remote Config. Una condición se dirige a un grupo específico de usuarios. Una lista de estas condiciones forma parte de una plantilla de Remote Config.
Parámetro de configuración remota	Interfaz que representa un parámetro de Remote Config. Como mínimo, debe estar presente una entrada defaultValue o conditionalValues ​​para que el parámetro tenga algún efecto.
Grupo de parámetros de configuración remota	Interfaz que representa un grupo de parámetros de Remote Config. La agrupación de parámetros es solo para fines de administración y no afecta la obtención de valores de parámetros por parte del cliente.
Plantilla de configuración remota	Interfaz que representa una plantilla de Remote Config.
UsuarioConfigRemoto	Interfaz que representa a un usuario de Remote Config.
Versión	Interfaz que representa una versión de la plantilla de Remote Config. Solo salida, excepto la descripción de la versión. Contiene metadatos sobre una versión particular 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 .

Tipo de alias

Tipo Alias	Descripción
Tipo de valor de parámetro	Tipo que representa un tipo de datos de valor de parámetro de Remote Config. El valor predeterminado es STRING si no se especifica.
Valor del parámetro de configuración remota	Tipo que representa un valor de parámetro de Remote Config. Un RemoteConfigParameterValue podría ser un ExplicitParameterValue o un InAppDefaultValue .
Color de etiqueta	Colores asociados a condiciones con fines de visualización.

obtenerRemoteConfig()

Obtiene el servicio RemoteConfig para la aplicación predeterminada o una aplicación determinada.

Se puede llamar getRemoteConfig() sin argumentos para acceder al servicio RemoteConfig de la aplicación predeterminada o como getRemoteConfig(app) para acceder al servicio RemoteConfig asociado con una aplicación específica.

Firma:

export declare function getRemoteConfig(app?: App): RemoteConfig;

Parámetros

Parámetro	Tipo	Descripción
aplicación	Aplicación	Aplicación opcional para devolver el servicio RemoteConfig . Si no se proporciona, se devuelve el servicio RemoteConfig predeterminado.

Devoluciones:

Configuración remota

El servicio RemoteConfig predeterminado si no se proporciona ninguna aplicación, o el servicio RemoteConfig asociado con la aplicación 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);

Tipo de valor de parámetro

Tipo que representa un tipo de datos de valor de parámetro de Remote Config. El valor predeterminado es STRING si no se especifica.

Firma:

export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';

Valor del parámetro de configuración remota

Tipo que representa un valor de parámetro de Remote Config. Un RemoteConfigParameterValue podría ser un ExplicitParameterValue o un InAppDefaultValue .

Firma:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

Color de etiqueta

Colores asociados a condiciones con fines de visualización.

Firma:

export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';