remote-config package

Das Firebase Remote Config Web SDK. Dieses SDK funktioniert nicht in einer Node.js-Umgebung.

Funktionen

Schnittstellen

Geben Sie Aliase ein

Funktion(App, ...)

getRemoteConfig(app)

Unterschrift:

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

Parameter

Kehrt zurück:

RemoteConfig

Eine RemoteConfig- Instanz.

Funktion(remoteConfig, ...)

aktivieren(remoteConfig)

Stellt den Gettern die zuletzt abgerufene Konfiguration zur Verfügung.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<boolean>

Ein Promise , das zu „true“ aufgelöst wird, wenn der aktuelle Aufruf die abgerufenen Konfigurationen aktiviert hat. Wenn die abgerufenen Konfigurationen bereits aktiviert waren, wird das Promise zu „false“ aufgelöst.

secureInitialized(remoteConfig)

Stellt sicher, dass den Gettern die zuletzt aktivierte Konfiguration zur Verfügung steht.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<void>

Ein Promise , das aufgelöst wird, wenn die letzte aktivierte Konfiguration für die Getter verfügbar ist.

fetchAndActivate(remoteConfig)

Führt der Einfachheit halber Abruf- und Aktivierungsvorgänge durch.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<boolean>

Ein Promise , das zu „true“ aufgelöst wird, wenn der aktuelle Aufruf die abgerufenen Konfigurationen aktiviert hat. Wenn die abgerufenen Konfigurationen bereits aktiviert waren, wird das Promise zu „false“ aufgelöst.

fetchConfig(remoteConfig)

Ruft die Konfiguration vom Remote Config-Dienst ab und speichert sie zwischen.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<void>

getAll(remoteConfig)

Ruft alle Konfigurationen ab.

Unterschrift:

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

Parameter

Kehrt zurück:

Record<string, Wert >

Alle Konfigurationen.

getBoolean(remoteConfig, Schlüssel)

Ruft den Wert für den angegebenen Schlüssel als booleschen Wert ab.

Praktische Methode zum Aufrufen remoteConfig.getValue(key).asBoolean() .

Unterschrift:

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

Parameter

Kehrt zurück:

Boolescher Wert

Der Wert für den angegebenen Schlüssel als boolescher Wert.

getNumber(remoteConfig, Schlüssel)

Ruft den Wert für den angegebenen Schlüssel als Zahl ab.

Praktische Methode zum Aufrufen remoteConfig.getValue(key).asNumber() .

Unterschrift:

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

Parameter

Kehrt zurück:

Nummer

Der Wert für den angegebenen Schlüssel als Zahl.

getString(remoteConfig, Schlüssel)

Ruft den Wert für den angegebenen Schlüssel als Zeichenfolge ab. Praktische Methode zum Aufrufen remoteConfig.getValue(key).asString() .

Unterschrift:

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

Parameter

Kehrt zurück:

Zeichenfolge

Der Wert für den angegebenen Schlüssel als Zeichenfolge.

getValue(remoteConfig, Schlüssel)

Ruft den Wert für den angegebenen Schlüssel ab.

Unterschrift:

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

Parameter

Kehrt zurück:

Wert

Der Wert für den angegebenen Schlüssel.

setLogLevel(remoteConfig, logLevel)

Definiert die zu verwendende Protokollebene.

Unterschrift:

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

Parameter

Kehrt zurück:

Leere

Funktion()

wird unterstützt()

Diese Methode bietet zwei verschiedene Prüfungen:

1. Überprüfen Sie, ob IndexedDB in der Browserumgebung vorhanden ist. 2. Überprüfen Sie, ob der aktuelle Browserkontext IndexedDB open() Aufrufe zulässt.

Unterschrift:

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

Kehrt zurück:

Versprechen<boolean>

Ein Promise , das zu „true“ aufgelöst wird, wenn eine RemoteConfig- Instanz in dieser Umgebung initialisiert werden kann, oder zu „false“, wenn dies nicht möglich ist.

FetchStatus

Fasst das Ergebnis des letzten Versuchs zusammen, die Konfiguration vom Firebase Remote Config-Server abzurufen.

• „no-fetch-yet“ zeigt an, dass die Instanz [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) noch nicht versucht hat, die Konfiguration abzurufen, oder dass die SDK-Initialisierung unvollständig ist.
• „Erfolg“ gibt an, dass der letzte Versuch erfolgreich war.
• „Fehler“ gibt an, dass der letzte Versuch fehlgeschlagen ist.
• „Throttle“ gibt an, dass der letzte Versuch ratenbegrenzt war.

Unterschrift:

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

LogLevel

Definiert Ebenen der Remote-Konfigurationsprotokollierung.

Unterschrift:

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

ValueSource

Gibt die Quelle eines Werts an.

• „statisch“ gibt an, dass der Wert durch eine statische Konstante definiert wurde.
• „default“ gibt an, dass der Wert in der Standardkonfiguration definiert wurde.
• „remote“ gibt an, dass der Wert durch die abgerufene Konfiguration definiert wurde.

Unterschrift:

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