remote-config package

Le SDK Web de configuration à distance Firebase. Ce SDK ne fonctionne pas dans un environnement Node.js.

Les fonctions

Interfaces

Tapez les alias

fonction(application, ...)

getRemoteConfig (application)

Signature:

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

Paramètres

Retour:

Configuration à distance

Une instance RemoteConfig .

fonction (remoteConfig, ...)

activer (remoteConfig)

Rend la dernière configuration récupérée à la disposition des getters.

Signature:

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

Paramètres

Retour:

Promesse<booléen>

Une Promise qui devient vraie si l'appel en cours a activé les configurations récupérées. Si les configurations récupérées étaient déjà activées, la Promise sera résolue comme fausse.

assurerInitialisé (remoteConfig)

Garantit que la dernière configuration activée est disponible pour les getters.

Signature:

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

Paramètres

Retour:

Promesse<vide>

Une Promise qui se résout lorsque la dernière configuration activée est disponible pour les getters.

fetchAndActivate (remoteConfig)

Effectue des opérations de récupération et d'activation, pour plus de commodité.

Signature:

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

Paramètres

Retour:

Promesse<booléen>

Une Promise qui devient vraie si l'appel en cours a activé les configurations récupérées. Si les configurations récupérées étaient déjà activées, la Promise sera résolue comme fausse.

fetchConfig (configuration à distance)

Récupère et met en cache la configuration du service Remote Config.

Signature:

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

Paramètres

Retour:

Promesse<vide>

getAll (configuration à distance)

Obtient toute la configuration.

Signature:

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

Paramètres

Retour:

Enregistrement<string, Value >

Toute la configuration.

getBoolean(remoteConfig, clé)

Obtient la valeur de la clé donnée sous forme booléenne.

Méthode pratique pour appeler remoteConfig.getValue(key).asBoolean() .

Signature:

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

Paramètres

Retour:

booléen

La valeur de la clé donnée sous forme booléenne.

getNumber (remoteConfig, clé)

Obtient la valeur de la clé donnée sous forme de nombre.

Méthode pratique pour appeler remoteConfig.getValue(key).asNumber() .

Signature:

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

Paramètres

Retour:

nombre

La valeur de la clé donnée sous forme de nombre.

getString (remoteConfig, clé)

Obtient la valeur de la clé donnée sous forme de chaîne. Méthode pratique pour appeler remoteConfig.getValue(key).asString() .

Signature:

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

Paramètres

Retour:

chaîne

La valeur de la clé donnée sous forme de chaîne.

getValue (remoteConfig, clé)

Obtient la valeur de la clé donnée.

Signature:

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

Paramètres

Retour:

Valeur

La valeur de la clé donnée.

setLogLevel (remoteConfig, logLevel)

Définit le niveau de journalisation à utiliser.

Signature:

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

Paramètres

Retour:

vide

fonction()

est pris en charge()

Cette méthode propose deux contrôles différents :

1. Vérifiez si IndexedDB existe dans l'environnement du navigateur. 2. Vérifiez si le contexte actuel du navigateur autorise les appels IndexedDB open() .

Signature:

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

Retour:

Promesse<booléen>

Une Promise qui prend la valeur true si une instance RemoteConfig peut être initialisée dans cet environnement, ou false si elle ne le peut pas.

Récupérer l'état

Résume le résultat de la dernière tentative de récupération de la configuration à partir du serveur Firebase Remote Config.

• "no-fetch-yet" indique que l'instance [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) n'a pas encore tenté de récupérer la configuration ou que l'initialisation du SDK est incomplète.
• « succès » indique que la dernière tentative a réussi.
• "échec" indique que la dernière tentative a échoué.
• « accélérateur » indique que la dernière tentative était limitée en débit.

Signature:

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

Niveau de journal

Définit les niveaux de journalisation de Remote Config.

Signature:

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

ValeurSource

Indique la source d'une valeur.

• "statique" indique que la valeur a été définie par une constante statique.
• "par défaut" indique que la valeur a été définie par la configuration par défaut.
• "remote" indique que la valeur a été définie par la configuration récupérée.

Signature:

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