RemoteConfig class

Interfejs usługi RemoteConfig Firebase.

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 z ciągu znaków JSON.
getServerTemplate(opcje) Tworzy instancję ServerTemplate, a potem pobiera i buforuje w pamięci podręcznej najnowszą wersję szablonu projektu.
getTemplate(), Pobiera bieżącą aktywną wersję RemoteConfigTemplate projektu.
getTemplateAtVersion(versionNumber) Pobiera żądaną wersję RemoteConfigTemplate projektu.
initServerTemplate(opcje) Synchronicznie tworzy instancję ServerTemplate.
listVersions(opcje) Pobiera listę wersji szablonów Zdalnej konfiguracji, które zostały posortowane w odwrotnej kolejności chronologicznej. Przechowywanych jest tylko ostatnich 300 wersji. Wszystkie wersje odpowiadające nieaktywnym szablonom Zdalnej konfiguracji (tzn. wszystkie z wyjątkiem szablonu pobieranego przez klientów) również są usuwane, jeśli są starsze niż 90 dni.
publishTemplate(szablon, opcje) Publikuje szablon Zdalnej konfiguracji.
rollback(versionNumber) Wycofuje opublikowany szablon Zdalnej konfiguracji projektu do określonej wersji. Wycofanie jest równoważne z uzyskaniem wcześniej opublikowanego szablonu Zdalnej konfiguracji i jego ponownym opublikowaniem przy użyciu wymuszonej aktualizacji.
validateTemplate(szablon) Weryfikuje RemoteConfigTemplate.

RemoteConfig.app

Podpis:

readonly app: App;

RemoteConfig.createTemplateFromJSON()

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

Podpis:

createTemplateFromJSON(json: string): RemoteConfigTemplate;

Parametry

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

Zwroty:

Szablon konfiguracji zdalnej

Nowa instancja szablonu.

RemoteConfig.getServerTemplate()

Tworzy instancję ServerTemplate, a potem pobiera i buforuje w pamięci podręcznej najnowszą wersję szablonu projektu.

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:

Promise<RemoteConfigTemplate>

Obietnica, która spełnia 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 | ciąg Numer wersji szablonu Zdalnej konfiguracji do wyszukania.

Zwroty:

Promise<RemoteConfigTemplate>

Obietnica, która spełnia się dzięki RemoteConfigTemplate.

RemoteConfig.initServerTemplate()

Synchronicznie tworzy instancję ServerTemplate.

Podpis:

initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;

Parametry

Parametr Typ Opis
opcje InitServerTemplateOptions

Zwroty:

Szablon serwera

RemoteConfig.listVersions()

Pobiera listę wersji szablonów Zdalnej konfiguracji, które zostały posortowane w odwrotnej kolejności chronologicznej. Przechowywanych jest tylko ostatnich 300 wersji. Wszystkie wersje odpowiadające nieaktywnym szablonom Zdalnej konfiguracji (tzn. wszystkie z wyjątkiem szablonu pobieranego przez klientów) również są usuwane, jeśli są starsze niż 90 dni.

Podpis:

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

Parametry

Parametr Typ Opis
opcje ListVersionsOptions Opcjonalny obiekt opcji pobierania listy wersji.

Zwroty:

Promise<ListVersionsResult>

Obietnica, która spełnia się dzięki ListVersionsResult.

RemoteConfig.publishTemplate()

Publikuje szablon Zdalnej konfiguracji.

Podpis:

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

Parametry

Parametr Typ Opis
szablon Szablon konfiguracji zdalnej Szablon Zdalnej konfiguracji do opublikowania.
opcje { force: boolean; } Opcjonalne obiekty opcji podczas publikowania szablonu Zdalnej konfiguracji: – force: ustawienie wartości true wymusza aktualizację szablonu Zdalnej konfiguracji i obejście tagu ETag. To podejście nie jest zalecane, ponieważ może spowodować utratę aktualizacji szablonu Zdalnej konfiguracji, jeśli będzie go aktualizować wiele klientów. Zobacz Używanie tagów ETag i wymuszone aktualizacje.

Zwroty:

Promise<RemoteConfigTemplate>

Obietnica, która spełnia się wraz z opublikowanym dokumentem RemoteConfigTemplate.

RemoteConfig.rollback()

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

Podpis:

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

Parametry

Parametr Typ Opis
Numer wersji liczba | ciąg Numer wersji szablonu Zdalnej konfiguracji, która 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) również są usuwane, jeśli mają ponad 90 dni.

Zwroty:

Promise<RemoteConfigTemplate>

Obietnica, która spełnia się wraz z opublikowanym dokumentem RemoteConfigTemplate.

RemoteConfig.validateTemplate()

Weryfikuje RemoteConfigTemplate.

Podpis:

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

Parametry

Parametr Typ Opis
szablon Szablon konfiguracji zdalnej Szablon Zdalnej konfiguracji do zweryfikowania.

Zwroty:

Promise<RemoteConfigTemplate>

Obietnica, która zostanie zrealizowana przy użyciu zweryfikowanych elementów typu RemoteConfigTemplate.