remote-config package

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

Funciones

Interfaces

Tipo de alias

función (aplicación, ...)

getRemoteConfig(aplicación)

Firma:

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

Parámetros

Devoluciones:

Configuración remota

Una instancia de RemoteConfig .

función (configuración remota, ...)

activar (configuración remota)

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

Firma:

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

Parámetros

Devoluciones:

Promesa<booleana>

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

asegurarIniciado(remoteConfig)

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

fetchAndActivate(configuración remota)

Realiza operaciones de búsqueda y activación, para su comodidad.

Firma:

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

Parámetros

Devoluciones:

Promesa<booleana>

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

fetchConfig(configuración remota)

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

getAll(configuración remota)

Obtiene todas las configuraciones.

Firma:

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

Parámetros

Devoluciones:

Registro<cadena, Valor >

Toda la configuración.

getBoolean(remoteConfig, clave)

Obtiene el valor de la clave dada como booleano.

Método conveniente para llamar remoteConfig.getValue(key).asBoolean() .

Firma:

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

Parámetros

Devoluciones:

booleano

El valor de la clave dada como booleano.

getNumber(configuración remota, clave)

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

Método conveniente para llamar remoteConfig.getValue(key).asNumber() .

Firma:

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

Parámetros

Devoluciones:

número

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

getString(remoteConfig, clave)

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

Firma:

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

Parámetros

Devoluciones:

cadena

El valor de la clave dada como una cadena.

getValue(configuración remota, clave)

Obtiene el valor de la clave proporcionada.

Firma:

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

Parámetros

Devoluciones:

Valor

El valor de la clave dada.

setLogLevel(remoteConfig, logLevel)

Define el nivel de registro que se utilizará.

Firma:

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

Parámetros

Devoluciones:

vacío

función()

esta apoyado()

Este método proporciona dos comprobaciones diferentes:

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

Firma:

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

Devoluciones:

Promesa<booleana>

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 inicializar.

Obtener estado

Resume el resultado del último intento de recuperar 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 recuperar 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 tuvo una 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';

Fuente de 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 se definió en la configuración predeterminada.
• "remoto" indica que el valor fue definido por la configuración recuperada.

Firma:

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