RemoteConfig class

Die Firebase RemoteConfig Dienstschnittstelle.

Unterschrift:

export declare class RemoteConfig

Eigenschaften

Eigentum Modifikatoren Typ Beschreibung
App App

Methoden

Methode Modifikatoren Beschreibung
createTemplateFromJSON(json) Erstellt eine neue Remote-Konfigurationsvorlage aus einer JSON-Zeichenfolge und gibt sie zurück.
getTemplate() Ruft die aktuell aktive Version des RemoteConfigTemplate des Projekts ab.
getTemplateAtVersion(versionNumber) Ruft die angeforderte Version des RemoteConfigTemplate des Projekts ab.
listVersions(Optionen) Ruft eine Liste der veröffentlichten Remote Config-Vorlagenversionen ab, sortiert in umgekehrter chronologischer Reihenfolge. Es werden nur die letzten 300 Versionen gespeichert. Alle Versionen, die nicht aktiven Remote-Config-Vorlagen entsprechen (also alle mit Ausnahme der Vorlage, die von Clients abgerufen wird), werden ebenfalls gelöscht, wenn sie älter als 90 Tage sind.
PublishTemplate(Vorlage, Optionen) Veröffentlicht eine Remote-Konfigurationsvorlage.
rollback(Versionsnummer) Setzt die veröffentlichte Remote-Konfigurationsvorlage eines Projekts auf die angegebene Version zurück. Ein Rollback entspricht dem Abrufen einer zuvor veröffentlichten Remote-Konfigurationsvorlage und deren erneuter Veröffentlichung mithilfe einer erzwungenen Aktualisierung.
validierenTemplate(Vorlage) Validiert ein RemoteConfigTemplate .

RemoteConfig.app

Unterschrift:

readonly app: App;

RemoteConfig.createTemplateFromJSON()

Erstellt eine neue Remote-Konfigurationsvorlage aus einer JSON-Zeichenfolge und gibt sie zurück.

Unterschrift:

createTemplateFromJSON(json: string): RemoteConfigTemplate;

Parameter

Parameter Typ Beschreibung
json Zeichenfolge Die JSON-Zeichenfolge zum Füllen einer Remote-Konfigurationsvorlage.

Kehrt zurück:

RemoteConfigTemplate

Eine neue Vorlageninstanz.

RemoteConfig.getTemplate()

Ruft die aktuell aktive Version des RemoteConfigTemplate des Projekts ab.

Unterschrift:

getTemplate(): Promise<RemoteConfigTemplate>;

Kehrt zurück:

Versprechen< RemoteConfigTemplate >

Ein Versprechen, das mit einem RemoteConfigTemplate erfüllt wird .

RemoteConfig.getTemplateAtVersion()

Ruft die angeforderte Version des RemoteConfigTemplate des Projekts ab.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Versionsnummer Nummer | Zeichenfolge Versionsnummer der nachzuschlagenden Remote-Konfigurationsvorlage.

Kehrt zurück:

Versprechen< RemoteConfigTemplate >

Ein Versprechen, das mit einem RemoteConfigTemplate erfüllt wird .

RemoteConfig.listVersions()

Ruft eine Liste der veröffentlichten Remote Config-Vorlagenversionen ab, sortiert in umgekehrter chronologischer Reihenfolge. Es werden nur die letzten 300 Versionen gespeichert. Alle Versionen, die nicht aktiven Remote-Config-Vorlagen entsprechen (also alle mit Ausnahme der Vorlage, die von Clients abgerufen wird), werden ebenfalls gelöscht, wenn sie älter als 90 Tage sind.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Optionen ListVersionsOptions Optionales Optionsobjekt zum Abrufen einer Versionsliste.

Kehrt zurück:

Versprechen< ListVersionsResult >

Ein Versprechen, das mit einem ListVersionsResult erfüllt wird .

RemoteConfig.publishTemplate()

Veröffentlicht eine Remote-Konfigurationsvorlage.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Vorlage RemoteConfigTemplate Die zu veröffentlichende Remote-Konfigurationsvorlage.
Optionen {force: boolean; } Optionales Optionsobjekt beim Veröffentlichen einer Remote-Config-Vorlage: - force : Wenn Sie dies auf true setzen, wird die Remote-Config-Vorlage aktualisiert und das ETag umgangen. Dieser Ansatz wird nicht empfohlen, da das Risiko besteht, dass Aktualisierungen Ihrer Remote Config-Vorlage verloren gehen, wenn mehrere Clients die Remote Config-Vorlage aktualisieren. Siehe ETag-Nutzung und erzwungene Updates .

Kehrt zurück:

Versprechen< RemoteConfigTemplate >

Ein Versprechen, das mit dem veröffentlichten RemoteConfigTemplate erfüllt wird .

RemoteConfig.rollback()

Setzt die veröffentlichte Remote-Konfigurationsvorlage eines Projekts auf die angegebene Version zurück. Ein Rollback entspricht dem Abrufen einer zuvor veröffentlichten Remote-Konfigurationsvorlage und deren erneuter Veröffentlichung mithilfe einer erzwungenen Aktualisierung.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Versionsnummer Nummer | Zeichenfolge Die Versionsnummer der Remote-Konfigurationsvorlage, auf die zurückgesetzt werden soll. Die angegebene Versionsnummer muss niedriger als die aktuelle Versionsnummer sein und darf nicht aufgrund von Veraltung gelöscht worden sein. Es werden nur die letzten 300 Versionen gespeichert. Alle Versionen, die nicht aktiven Remote Config-Vorlagen entsprechen (also alle mit Ausnahme der Vorlage, die von Clients abgerufen wird), werden ebenfalls gelöscht, wenn sie älter als 90 Tage sind.

Kehrt zurück:

Versprechen< RemoteConfigTemplate >

Ein Versprechen, das mit dem veröffentlichten RemoteConfigTemplate erfüllt wird .

RemoteConfig.validateTemplate()

Validiert ein RemoteConfigTemplate .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Vorlage RemoteConfigTemplate Die zu validierende Remote-Konfigurationsvorlage.

Kehrt zurück:

Versprechen< RemoteConfigTemplate >

Ein Versprechen, das mit dem validierten RemoteConfigTemplate erfüllt wird .