RemoteConfig class

Interfejs usługi Firebase RemoteConfig.

Podpis:

export declare class RemoteConfig

Właściwości

Właściwość Modyfikatory Typ Opis
aplikacja Aplikacja

Metody

Metoda Modyfikatory Opis
createTemplateFromJSON(json) Tworzy i zwraca nowy szablon Zdalnej konfiguracji na podstawie ciągu znaków JSON.
getServerTemplate(opcje) Tworzy instancję ServerTemplate, a następnie pobiera i zapisuje najnowszą wersję szablonu projektu w pamięci podręcznej.
getTemplate() Pobiera bieżącą aktywną wersję RemoteConfigTemplate projektu.
getTemplateAtVersion(versionNumber) Pobiera żądaną wersję RemoteConfigTemplate projektu.
initServerTemplate(opcje) Synchronizuje wystąpienie ServerTemplate.
listVersions(options). Pobiera listę opublikowanych wersji szablonów Zdalnej konfiguracji, posortowanych w odwrotnej kolejności chronologicznej. Przechowywanych jest tylko ostatnich 300 wersji. Wszystkie wersje odpowiadające nieaktywnym szablonom Zdalnej konfiguracji (tj. wszystkie z wyjątkiem szablonu pobieranego przez klienty) też są usuwane, jeśli są starsze niż 90 dni.
publishTemplate(szablon; opcje) Publikuje szablon Zdalnej konfiguracji.
rollback(versionNumber) Przywraca opublikowany szablon Zdalnej konfiguracji projektu do określonej wersji. Wycofanie jest równoważne z pobraniem wcześniej opublikowanego szablonu Zdalnej konfiguracji i ponownym opublikowaniem go przy użyciu wymuszonej aktualizacji.
validateTemplate(template) Weryfikuje RemoteConfigTemplate.

Zdalna konfiguracja.aplikacja

Podpis:

readonly app: App;

RemoteConfig.createTemplateFromJSON()

Tworzy i zwraca nowy szablon Zdalnej konfiguracji na podstawie ciągu znaków JSON.

Podpis:

createTemplateFromJSON(json: string): RemoteConfigTemplate;

Parametry

Parametr Typ Opis
JSON ciąg znaków Ciąg znaków JSON do wypełnienia szablonu Zdalnej konfiguracji.

Zwroty:

RemoteConfigTemplate,

Nową instancję szablonu.

RemoteConfig.getServerTemplate()

Tworzy instancję ServerTemplate, a następnie pobiera i zapisuje najnowszą wersję szablonu projektu w pamięci podręcznej.

Podpis:

getServerTemplate(options?: GetServerTemplateOptions): Promise<ServerTemplate>;

Parametry

Parametr Typ Opis
opcje GetServerTemplateOptions

Zwroty:

Obietnica<szablon serwera>

RemoteConfig.getTemplate()

Pobiera bieżącą aktywną wersję RemoteConfigTemplate projektu.

Podpis:

getTemplate(): Promise<RemoteConfigTemplate>;

Zwroty:

Obietnica<RemoteConfigTemplate>

Obietnica spełniająca się dzięki RemoteConfigTemplate.

RemoteConfig.getTemplateAtVersion()

Pobiera żądaną wersję RemoteConfigTemplate projektu.

Podpis:

getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;

Parametry

Parametr Typ Opis
numer wersji liczba | tekst Numer wersji szablonu Zdalnej konfiguracji do wyszukania.

Zwroty:

Obietnica<RemoteConfigTemplate>

Obietnica spełniająca się dzięki RemoteConfigTemplate.

RemoteConfig.initServerTemplate()

Synchronizuje wystąpienie ServerTemplate.

Podpis:

initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;

Parametry

Parametr Typ Opis
opcje InitServerTemplateOptions

Zwroty:

Szablon serwera

Zdalna konfiguracja.listVersions()

Pobiera listę opublikowanych wersji szablonów Zdalnej konfiguracji, posortowanych w odwrotnej kolejności chronologicznej. Przechowywanych jest tylko ostatnich 300 wersji. Wszystkie wersje odpowiadające nieaktywnym szablonom Zdalnej konfiguracji (tj. wszystkie z wyjątkiem szablonu pobieranego przez klienty) też są usuwane, jeśli są starsze niż 90 dni.

Podpis:

listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;

Parametry

Parametr Typ Opis
opcje ListVersionsOptions. Opcjonalny obiekt opcji służący do pobierania listy wersji.

Zwroty:

Obietnica<ListVersionsResult>

Obietnica spełniająca się dzięki ListVersionsResult.

RemoteConfig.publishTemplate()

Publikuje szablon Zdalnej konfiguracji.

Podpis:

publishTemplate(template: RemoteConfigTemplate, options?: {
        force: boolean;
    }): Promise<RemoteConfigTemplate>;

Parametry

Parametr Typ Opis
szablon RemoteConfigTemplate, Szablon Zdalnej konfiguracji do opublikowania.
opcje { force: boolean; Opcjonalne opcje w przypadku publikowania szablonu Zdalnej konfiguracji: – force: ustawienie dla tej opcji ustawienia na wartość true wymusza aktualizację szablonu Zdalnej konfiguracji i obchodzenie tagu ETag. To rozwiązanie nie jest zalecane, ponieważ może spowodować utratę aktualizacji szablonu Zdalnej konfiguracji w przypadku aktualizacji tego szablonu przez wielu klientów. Zapoznaj się z sekcją Korzystanie z ETag i wymuszanie aktualizacji.

Zwroty:

Obietnica<RemoteConfigTemplate>

Obietnica spełniająca się dzięki opublikowanym RemoteConfigTemplate.

Zdalna konfiguracja.rollback()

Przywraca opublikowany szablon Zdalnej konfiguracji projektu do określonej wersji. Wycofanie jest równoważne z pobraniem wcześniej opublikowanego szablonu Zdalnej konfiguracji i ponownym opublikowaniem go przy użyciu wymuszonej aktualizacji.

Podpis:

rollback(versionNumber: number | string): Promise<RemoteConfigTemplate>;

Parametry

Parametr Typ Opis
numer wersji liczba | tekst Numer wersji szablonu Zdalnej konfiguracji, do której ma zostać przywrócona. Podany numer wersji musi być niższy od bieżącego numeru wersji i nie został usunięty z powodu braku aktualizacji. Przechowywanych jest tylko ostatnich 300 wersji. Wszystkie wersje odpowiadające nieaktywnym szablonom Zdalnej konfiguracji (czyli wszystkie z wyjątkiem szablonu pobieranego przez klientów) też są usuwane, jeśli mają ponad 90 dni.

Zwroty:

Obietnica<RemoteConfigTemplate>

Obietnica spełniająca się w opublikowanym dokumencie RemoteConfigTemplate.

RemoteConfig.validateTemplate()

Weryfikuje RemoteConfigTemplate.

Podpis:

validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;

Parametry

Parametr Typ Opis
szablon RemoteConfigTemplate, Szablon Zdalnej konfiguracji do zweryfikowania.

Zwroty:

Obietnica<RemoteConfigTemplate>

Obietnica spełniająca się dzięki zweryfikowanemu RemoteConfigTemplate.