L'interface du service Firebase RemoteConfig .
Signature:
export declare class RemoteConfig
Propriétés
| Propriété | Modificateurs | Taper | Description |
|---|---|---|---|
| application | Application |
Méthodes
| Méthode | Modificateurs | Description |
|---|---|---|
| créerTemplateFromJSON(json) | Crée et renvoie un nouveau modèle Remote Config à partir d'une chaîne JSON. | |
| getTemplate() | Obtient la version active actuelle du RemoteConfigTemplate du projet. | |
| getTemplateAtVersion (numéro de version) | Obtient la version demandée du RemoteConfigTemplate du projet. | |
| listeVersions(options) | Obtient une liste des versions de modèles Remote Config qui ont été publiées, triées par ordre chronologique inverse. Seules les 300 dernières versions sont stockées. Toutes les versions qui correspondent à des modèles Remote Config non actifs (c'est-à-dire toutes sauf le modèle récupéré par les clients) sont également supprimées si elles datent de plus de 90 jours. | |
| publierTemplate(modèle, options) | Publie un modèle de configuration à distance. | |
| restauration (numéro de version) | Restaure le modèle Remote Config publié d'un projet vers la version spécifiée. Une restauration équivaut à obtenir un modèle Remote Config précédemment publié et à le republier à l'aide d'une mise à jour forcée. | |
| validateTemplate(modèle) | Valide un RemoteConfigTemplate . |
RemoteConfig.app
Signature:
readonly app: App;
RemoteConfig.createTemplateFromJSON()
Crée et renvoie un nouveau modèle Remote Config à partir d'une chaîne JSON.
Signature:
createTemplateFromJSON(json: string): RemoteConfigTemplate;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| json | chaîne | Chaîne JSON pour remplir un modèle Remote Config. |
Retour:
Modèle de configuration distant
Une nouvelle instance de modèle.
RemoteConfig.getTemplate()
Obtient la version active actuelle du RemoteConfigTemplate du projet.
Signature:
getTemplate(): Promise<RemoteConfigTemplate>;
Retour:
Promesse < RemoteConfigTemplate >
Une promesse qui se réalise avec un RemoteConfigTemplate .
RemoteConfig.getTemplateAtVersion()
Obtient la version demandée du RemoteConfigTemplate du projet.
Signature:
getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| numéro de version | numéro | chaîne | Numéro de version du modèle Remote Config à rechercher. |
Retour:
Promesse < RemoteConfigTemplate >
Une promesse qui se réalise avec un RemoteConfigTemplate .
RemoteConfig.listVersions()
Obtient une liste des versions de modèles Remote Config qui ont été publiées, triées par ordre chronologique inverse. Seules les 300 dernières versions sont stockées. Toutes les versions qui correspondent à des modèles Remote Config non actifs (c'est-à-dire toutes sauf le modèle récupéré par les clients) sont également supprimées si elles datent de plus de 90 jours.
Signature:
listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| choix | Liste des options de versions | Objet d'options facultatif pour obtenir une liste de versions. |
Retour:
Promesse< ListVersionsResult >
Une promesse qui se réalise avec un ListVersionsResult .
RemoteConfig.publishTemplate()
Publie un modèle de configuration à distance.
Signature:
publishTemplate(template: RemoteConfigTemplate, options?: {
force: boolean;
}): Promise<RemoteConfigTemplate>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| modèle | Modèle de configuration distant | Le modèle Remote Config à publier. |
| choix | { force : booléen ; } | Objet d'options facultatives lors de la publication d'un modèle Remote Config : - force : définir ceci sur true force la mise à jour du modèle Remote Config et contourne l'ETag. Cette approche n'est pas recommandée car elle risque d'entraîner la perte des mises à jour de votre modèle Remote Config si plusieurs clients mettent à jour le modèle Remote Config. Voir l'utilisation d'ETag et les mises à jour forcées . |
Retour:
Promesse < RemoteConfigTemplate >
Une promesse qui se réalise avec le RemoteConfigTemplate publié .
RemoteConfig.rollback()
Restaure le modèle Remote Config publié d'un projet vers la version spécifiée. Une restauration équivaut à obtenir un modèle Remote Config précédemment publié et à le republier à l'aide d'une mise à jour forcée.
Signature:
rollback(versionNumber: number | string): Promise<RemoteConfigTemplate>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| numéro de version | numéro | chaîne | Numéro de version du modèle Remote Config vers lequel revenir. Le numéro de version spécifié doit être inférieur au numéro de version actuel et ne pas avoir été supprimé pour cause d'obsolescence. Seules les 300 dernières versions sont stockées. Toutes les versions qui correspondent à des modèles Remote Config non actifs (c'est-à-dire toutes sauf le modèle récupéré par les clients) sont également supprimées si elles datent de plus de 90 jours. |
Retour:
Promesse < RemoteConfigTemplate >
Une promesse qui tient avec le RemoteConfigTemplate publié .
RemoteConfig.validateTemplate()
Valide un RemoteConfigTemplate .
Signature:
validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| modèle | Modèle de configuration distant | Le modèle Remote Config à valider. |
Retour:
Promesse < RemoteConfigTemplate >
Une promesse qui tient avec le RemoteConfigTemplate validé .