remote-config package

Internetowy pakiet SDK Zdalnej konfiguracji Firebase. Ten pakiet SDK nie działa w środowisku Node.js.

Funkcje

Funkcja Opis
function(aplikacja, ...)
getRemoteConfig(aplikacja)
function(remoteConfig, ...)
activate(remoteConfig) Udostępnia mechanizmom pobierającym ostatnią pobraną konfigurację.
ensureInitialized(remoteConfig) Zapewnia, że ostatnia aktywowana konfiguracja jest dostępna dla metod pobierających.
fetchAndActivate(remoteConfig) Wykonuje operacje pobierania i aktywacji dla wygody użytkowników.
fetchConfig(remoteConfig) Pobiera i zapisuje konfigurację w pamięci podręcznej z usługi Zdalnej konfiguracji.
getAll(remoteConfig) Pobiera całą konfigurację.
getBoolean(remoteConfig, klucz) Pobiera wartość danego klucza jako wartość logiczną.Wygodna metoda wywoływania remoteConfig.getValue(key).asBoolean().
getNumber(remoteConfig, klucz) Pobiera wartość danego klucza jako liczbę.Wygodna metoda wywołania remoteConfig.getValue(key).asNumber().
getString(remoteConfig, klucz) Pobiera wartość danego klucza w postaci ciągu znaków. Wygodna metoda wywoływania usługi remoteConfig.getValue(key).asString().
getValue(remoteConfig, klucz) Pobiera Wartość danego klucza.
setLogLevel(remoteConfig, logLevel) Określa poziom logowania, który ma być używany.
function()
isSupported() W ramach tej metody można korzystać z 2 różnych testów:1. Sprawdź, czy w środowisku przeglądarki istnieje obiekt IndexedDB. 2. Sprawdź, czy bieżący kontekst przeglądarki zezwala na wywołania IndexedDB open().

Interfejsy

Interfejs Opis
Zdalna konfiguracja Interfejs usługi Zdalnej konfiguracji Firebase.
RemoteConfigSettings, Określa opcje konfiguracji pakietu SDK Zdalnej konfiguracji.
Wartość Zawija wartość przy użyciu metadanych i metod pobierania bezpiecznych typu.

Aliasy typu

Wpisz alias Opis
FetchStatus (Stan pobierania) Podsumowuje wynik ostatniej próby pobrania konfiguracji z serwera Zdalnej konfiguracji Firebase.
  • „jeszcze nie pobrany” wskazuje, że instancja RemoteConfig nie próbowała jeszcze pobrać konfiguracji lub że inicjowanie pakietu SDK nie zostało zakończone.
  • „sukces” wskazuje ostatnią udaną próbę.
  • „niepowodzenie” wskazuje, że ostatnia próba zakończyła się niepowodzeniem.
  • „ograniczyć” wskazuje, że ostatnia próba była ograniczona czasowo.
LogLevel (Poziom rejestrowania). Określa poziomy rejestrowania Zdalnej konfiguracji.
ValueSource, Wskazuje źródło wartości.
  • „statyczne” wskazuje, że wartość została zdefiniowana przez stałą statyczną.
  • „domyślna” wskazuje wartość zdefiniowaną przez konfigurację domyślną.
  • „pilot” wskazuje, że wartość została zdefiniowana przez pobraną konfigurację.

funkcja(aplikacja, ...)

getRemoteConfig(aplikacja)

Podpis:

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

Parametry

Parametr Typ Opis
aplikacja Aplikacja Firebase Instancja FirebaseApp.

Zwroty:

Zdalna konfiguracja

Instancja RemoteConfig.

funkcja(remoteConfig, ...)

aktywacja(remoteConfig)

Udostępnia mechanizmom pobierającym ostatnią pobraną konfigurację.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna_konfiguracja Zdalna konfiguracja Instancja RemoteConfig.

Zwroty:

Promise&lt;boolean&gt;

Promise, który przyjmuje wartość prawda, jeśli bieżące wywołanie aktywuje pobrane konfiguracje. Jeśli pobrane konfiguracje zostały już aktywowane, Promise zmieni wartość na fałsz.

upewnij się, że zainicjowano(zdalna konfiguracja)

Zapewnia, że ostatnia aktywowana konfiguracja jest dostępna dla metod pobierających.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna_konfiguracja Zdalna konfiguracja Instancja RemoteConfig.

Zwroty:

Obietnica<void>

Identyfikator Promise, który kończy się, gdy ostatnia aktywowana konfiguracja jest dostępna dla metod pobierania.

downloadAndActivate(remoteConfig)

Wykonuje operacje pobierania i aktywacji dla wygody użytkowników.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna_konfiguracja Zdalna konfiguracja Instancja RemoteConfig.

Zwroty:

Promise&lt;boolean&gt;

Promise, który przyjmuje wartość prawda, jeśli bieżące wywołanie aktywuje pobrane konfiguracje. Jeśli pobrane konfiguracje zostały już aktywowane, Promise zmieni wartość na fałsz.

downloadConfig(remoteConfig)

Pobiera i zapisuje konfigurację w pamięci podręcznej z usługi Zdalnej konfiguracji.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna_konfiguracja Zdalna konfiguracja Instancja RemoteConfig.

Zwroty:

Obietnica<void>

getAll(remoteConfig)

Pobiera całą konfigurację.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna_konfiguracja Zdalna konfiguracja Instancja RemoteConfig.

Zwroty:

Rekord<string, Wartość>

Cała konfiguracja.

getBoolean(zdalna konfiguracja; klucz)

Pobiera wartość danego klucza jako wartość logiczną.

Wygodna metoda wywoływania usługi remoteConfig.getValue(key).asBoolean().

Podpis:

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

Parametry

Parametr Typ Opis
zdalna_konfiguracja Zdalna konfiguracja Instancja RemoteConfig.
klucz ciąg znaków Nazwa parametru.

Zwroty:

wartość logiczna

Wartość podanego klucza w postaci wartości logicznej.

getNumber(zdalna konfiguracja; klucz)

Pobiera wartość danego klucza w postaci liczby.

Wygodna metoda wywoływania usługi remoteConfig.getValue(key).asNumber().

Podpis:

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

Parametry

Parametr Typ Opis
zdalna_konfiguracja Zdalna konfiguracja Instancja RemoteConfig.
klucz ciąg znaków Nazwa parametru.

Zwroty:

liczba

Wartość danego klucza w postaci liczby.

getString(remoteConfig, klucz)

Pobiera wartość danego klucza w postaci ciągu znaków. Wygodna metoda wywoływania usługi remoteConfig.getValue(key).asString().

Podpis:

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

Parametry

Parametr Typ Opis
zdalna_konfiguracja Zdalna konfiguracja Instancja RemoteConfig.
klucz ciąg znaków Nazwa parametru.

Zwroty:

ciąg znaków

Wartość danego klucza w postaci ciągu znaków.

getValue(remoteConfig; klucz)

Pobiera Wartość danego klucza.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna_konfiguracja Zdalna konfiguracja Instancja RemoteConfig.
klucz ciąg znaków Nazwa parametru.

Zwroty:

Wartość

Wartość danego klucza.

setLogLevel(remoteConfig, logLevel)

Określa poziom logowania, który ma być używany.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna_konfiguracja Zdalna konfiguracja Instancja RemoteConfig.
poziom logu RemoteConfigLogLevel Poziom logowania, który ma zostać ustawiony.

Zwroty:

nieważne

funkcja()

issupported()

Ta metoda przeprowadza weryfikację na 2 sposoby:

  1. Sprawdź, czy w środowisku przeglądarki istnieje obiekt IndexedDB. 2. Sprawdź, czy bieżący kontekst przeglądarki zezwala na wywołania IndexedDB open().

Podpis:

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

Zwroty:

Promise&lt;boolean&gt;

Promise, który przyjmuje wartość „prawda”, jeśli w tym środowisku można zainicjować instancję RemoteConfig, lub wartość „false”, jeśli nie jest to możliwe.

FetchStatus

Podsumowuje wynik ostatniej próby pobrania konfiguracji z serwera Zdalnej konfiguracji Firebase.

  • „jeszcze nie pobrany” wskazuje, że instancja [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) nie próbował jeszcze pobrać konfiguracji lub że inicjowanie pakietu SDK nie zostało zakończone.
  • „sukces” wskazuje ostatnią udaną próbę.
  • „niepowodzenie” wskazuje, że ostatnia próba zakończyła się niepowodzeniem.
  • „ograniczyć” wskazuje, że ostatnia próba była ograniczona czasowo.

Podpis:

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

Poziom logu

Określa poziomy rejestrowania Zdalnej konfiguracji.

Podpis:

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

Źródło wartości

Wskazuje źródło wartości.

  • „statyczne” wskazuje, że wartość została zdefiniowana przez stałą statyczną.
  • „domyślna” wskazuje wartość zdefiniowaną przez konfigurację domyślną.
  • „pilot” wskazuje, że wartość została zdefiniowana przez pobraną konfigurację.

Podpis:

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