remote-config package

L'SDK Web Firebase Remote Config. Questo SDK non funziona in un ambiente Node.js.

Funzioni

Interfacce

Digitare Alias

funzione(app, ...)

getRemoteConfig(app)

Firma:

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

Parametri

Ritorna:

Configurazione remota

Un'istanza RemoteConfig .

funzione(remoteConfig, ...)

attivare(remoteConfig)

Rende disponibile ai getter l'ultima configurazione recuperata.

Firma:

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

Parametri

Ritorna:

Promesso<booleano>

Una Promise che diventa vera se la chiamata corrente ha attivato le configurazioni recuperate. Se le configurazioni recuperate erano già attivate, la Promise verrà risolta in false.

garantireInitialized(remoteConfig)

Garantisce che l'ultima configurazione attivata sia disponibile per i getter.

Firma:

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

Parametri

Ritorna:

Promesso<vuoto>

Una Promise che si risolve quando l'ultima configurazione attivata è disponibile per i getter.

fetchAndActivate(remoteConfig)

Esegue operazioni di recupero e attivazione, per comodità.

Firma:

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

Parametri

Ritorna:

Promesso<booleano>

Una Promise che diventa vera se la chiamata corrente ha attivato le configurazioni recuperate. Se le configurazioni recuperate erano già attivate, la Promise verrà risolta in false.

fetchConfig(remoteConfig)

Recupera e memorizza nella cache la configurazione dal servizio Remote Config.

Firma:

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

Parametri

Ritorna:

Promesso<vuoto>

getAll(remoteConfig)

Ottiene tutta la configurazione.

Firma:

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

Parametri

Ritorna:

Registra<stringa, valore >

Tutte le configurazioni.

getBoolean(remoteConfig, chiave)

Ottiene il valore per la chiave specificata come valore booleano.

Metodo pratico per chiamare remoteConfig.getValue(key).asBoolean() .

Firma:

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

Parametri

Ritorna:

booleano

Il valore per la chiave specificata come booleano.

getNumber(remoteConfig, chiave)

Ottiene il valore della chiave specificata come numero.

Metodo pratico per chiamare remoteConfig.getValue(key).asNumber() .

Firma:

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

Parametri

Ritorna:

numero

Il valore della chiave specificata sotto forma di numero.

getString(remoteConfig, chiave)

Ottiene il valore della chiave specificata come stringa. Metodo pratico per chiamare remoteConfig.getValue(key).asString() .

Firma:

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

Parametri

Ritorna:

corda

Il valore della chiave specificata come stringa.

getValue(remoteConfig, chiave)

Ottiene il valore per la chiave specificata.

Firma:

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

Parametri

Ritorna:

Valore

Il valore per la chiave specificata.

setLogLevel(remoteConfig, logLevel)

Definisce il livello di registro da utilizzare.

Firma:

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

Parametri

Ritorna:

vuoto

funzione()

è supportato()

Questo metodo prevede due diversi controlli:

1. Controlla se IndexedDB esiste nell'ambiente del browser. 2. Controlla se il contesto del browser corrente consente le chiamate open() di IndexedDB.

Firma:

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

Ritorna:

Promesso<booleano>

Una Promise che restituisce true se un'istanza RemoteConfig può essere inizializzata in questo ambiente o false in caso contrario.

FetchStatus

Riepiloga il risultato dell'ultimo tentativo di recuperare la configurazione dal server Firebase Remote Config.

• "no-fetch-yet" indica che l'istanza [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) non ha ancora tentato di recuperare la configurazione o che l'inizializzazione dell'SDK è incompleta.
• "successo" indica l'ultimo tentativo riuscito.
• "fallimento" indica l'ultimo tentativo fallito.
• "throttle" indica che l'ultimo tentativo era a velocità limitata.

Firma:

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

LogLevel

Definisce i livelli di registrazione di Remote Config.

Firma:

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

ValueSource

Indica l'origine di un valore.

• "statico" indica che il valore è stato definito da una costante statica.
• "default" indica che il valore è stato definito dalla configurazione predefinita.
• "remoto" indica che il valore è stato definito dalla configurazione recuperata.

Firma:

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