remote-config package

El SDK web de Firebase Remote Config. Este SDK no funciona en un entorno Node.js.

Funciones

Función Descripción
función (aplicación...)
getRemoteConfig(aplicación)
función (configuración remota...)
activar (configuración remota) Hace que la última configuración recuperada esté disponible para los captadores.
asegurarInicializado(remoteConfig) Garantiza que la última configuración activada esté disponible para los captadores.
buscar y activar (configuración remota) Realiza operaciones de búsqueda y activación, como conveniencia.
fetchConfig(remoteConfig) Obtiene y almacena en caché la configuración del servicio Remote Config.
getAll(remoteConfig) Obtiene toda la configuración.
getBoolean(remoteConfig, clave) Obtiene el valor de la clave especificada como valor booleano. Método práctico para llamar remoteConfig.getValue(key).asBoolean() .
getNumber(remoteConfig, clave) Obtiene el valor de la clave dada como un número. Método práctico para llamar remoteConfig.getValue(key).asNumber() .
getString(remoteConfig, clave) Obtiene el valor de la clave dada como una cadena. Método práctico para llamar remoteConfig.getValue(key).asString() .
getValue(remoteConfig, clave) Obtiene el valor de la clave dada.
setLogLevel (configuración remota, nivel de registro) Define el nivel de registro a utilizar.
función()
esta apoyado() Este método proporciona dos comprobaciones diferentes: 1. Verifique si IndexedDB existe en el entorno del navegador. 2. Verifique si el contexto del navegador actual permite las llamadas open() de IndexedDB.

Interfaces

Interfaz Descripción
Configuración remota La interfaz del servicio Firebase Remote Config.
Ajustes de configuración remota Define las opciones de configuración para el SDK de Remote Config.
Valor Envuelve un valor con metadatos y captadores de tipo seguro.

Tipo de alias

Alias ​​de tipo Descripción
FetchStatus Resume el resultado del último intento de obtener la configuración del servidor Firebase Remote Config.
  • "no-fetch-yet" indica que la instancia de RemoteConfig aún no ha intentado obtener la configuración o que la inicialización del SDK está incompleta.
  • "éxito" indica que el último intento tuvo éxito.
  • "fracaso" indica que el último intento falló.
  • "acelerador" indica que el último intento fue de velocidad limitada.
Nivel de registro Define los niveles de registro de Remote Config.
Origen del valor Indica la fuente de un valor.
  • "estático" indica que el valor fue definido por una constante estática.
  • "predeterminado" indica que el valor fue definido por la configuración predeterminada.
  • "remoto" indica que el valor fue definido por la configuración obtenida.

getRemoteConfig()

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación FirebaseApp La instancia de FirebaseApp .

Devoluciones:

Configuración remota

Una instancia de RemoteConfig .

activar()

Hace que la última configuración recuperada esté disponible para los captadores.

Firma:

export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;

Parámetros

Parámetro Tipo Descripción
configuración remota Configuración remota La instancia de RemoteConfig .

Devoluciones:

Promesa<booleano>

Una Promise que se resuelve en verdadero si la llamada actual activó las configuraciones obtenidas. Si las configuraciones recuperadas ya estaban activadas, la Promise se resolverá como falsa.

asegurarInicializado()

Garantiza que la última configuración activada esté disponible para los captadores.

Firma:

export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;

Parámetros

Parámetro Tipo Descripción
configuración remota Configuración remota La instancia de RemoteConfig .

Devoluciones:

Promesa <vacío>

Una Promise que se resuelve cuando la última configuración activada está disponible para los captadores.

buscar y activar ()

Realiza operaciones de búsqueda y activación, como conveniencia.

Firma:

export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;

Parámetros

Parámetro Tipo Descripción
configuración remota Configuración remota La instancia de RemoteConfig .

Devoluciones:

Promesa<booleano>

Una Promise que se resuelve en verdadero si la llamada actual activó las configuraciones obtenidas. Si las configuraciones recuperadas ya estaban activadas, la Promise se resolverá como falsa.

fetchConfig()

Obtiene y almacena en caché la configuración del servicio Remote Config.

Firma:

export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;

Parámetros

Parámetro Tipo Descripción
configuración remota Configuración remota La instancia de RemoteConfig .

Devoluciones:

Promesa <vacío>

obtener toda()

Obtiene toda la configuración.

Firma:

export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;

Parámetros

Parámetro Tipo Descripción
configuración remota Configuración remota La instancia de RemoteConfig .

Devoluciones:

Registro<cadena, Valor >

Toda la configuración.

obtenerBooleano()

Obtiene el valor de la clave especificada como valor booleano.

Método práctico para llamar remoteConfig.getValue(key).asBoolean() .

Firma:

export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;

Parámetros

Parámetro Tipo Descripción
configuración remota Configuración remota La instancia de RemoteConfig .
llave cadena El nombre del parámetro.

Devoluciones:

booleano

El valor de la clave dada como un valor booleano.

obtenerNúmero()

Obtiene el valor de la clave dada como un número.

Método práctico para llamar remoteConfig.getValue(key).asNumber() .

Firma:

export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;

Parámetros

Parámetro Tipo Descripción
configuración remota Configuración remota La instancia de RemoteConfig .
llave cadena El nombre del parámetro.

Devoluciones:

número

El valor de la clave dada como un número.

obtenerCadena()

Obtiene el valor de la clave dada como una cadena. Método práctico para llamar remoteConfig.getValue(key).asString() .

Firma:

export declare function getString(remoteConfig: RemoteConfig, key: string): string;

Parámetros

Parámetro Tipo Descripción
configuración remota Configuración remota La instancia de RemoteConfig .
llave cadena El nombre del parámetro.

Devoluciones:

cadena

El valor de la clave dada como una cadena.

obtenerValor()

Obtiene el valor de la clave dada.

Firma:

export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;

Parámetros

Parámetro Tipo Descripción
configuración remota Configuración remota La instancia de RemoteConfig .
llave cadena El nombre del parámetro.

Devoluciones:

Valor

El valor de la clave dada.

establecer nivel de registro ()

Define el nivel de registro a utilizar.

Firma:

export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;

Parámetros

Parámetro Tipo Descripción
configuración remota Configuración remota La instancia de RemoteConfig .
nivel de registro RemoteConfigLogLevel El nivel de registro a establecer.

Devoluciones:

vacío

esta apoyado()

Este método proporciona dos comprobaciones diferentes:

  1. Compruebe si IndexedDB existe en el entorno del navegador. 2. Verifique si el contexto del navegador actual permite las llamadas open() de IndexedDB.

Firma:

export declare function isSupported(): Promise<boolean>;

Devoluciones:

Promesa<booleano>

Una Promise que se resuelve en verdadero si una instancia de RemoteConfig se puede inicializar en este entorno o en falso si no se puede.

FetchStatus

Resume el resultado del último intento de obtener la configuración del servidor Firebase Remote Config.

  • "no-fetch-yet" indica que la instancia [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) aún no ha intentado obtener la configuración o que la inicialización del SDK está incompleta.
  • "éxito" indica que el último intento tuvo éxito.
  • "fracaso" indica que el último intento falló.
  • "acelerador" indica que el último intento fue de velocidad limitada.

Firma:

export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';

Nivel de registro

Define los niveles de registro de Remote Config.

Firma:

export declare type LogLevel = 'debug' | 'error' | 'silent';

Origen del valor

Indica la fuente de un valor.

  • "estático" indica que el valor fue definido por una constante estática.
  • "predeterminado" indica que el valor fue definido por la configuración predeterminada.
  • "remoto" indica que el valor fue definido por la configuración obtenida.

Firma:

export declare type ValueSource = 'static' | 'default' | 'remote';