firebase-admin.remote-config package

Configuration à distance Firebase.

Les fonctions

Fonction Description
getRemoteConfig (application) Obtient le service RemoteConfig pour l'application par défaut ou une application donnée. getRemoteConfig() peut être appelé sans argument pour accéder au service RemoteConfig de l'application par défaut ou en tant que getRemoteConfig(app) pour accéder au service RemoteConfig associé à une application spécifique.

Des classes

Classe Description
Configuration à distance L'interface du service Firebase RemoteConfig .

Interfaces

Interface Description
Valeur du paramètre explicite Interface représentant une valeur de paramètre explicite.
InAppDefaultValue Interface représentant une valeur par défaut dans l'application.
Liste des options de versions Interface représentant les options pour le fonctionnement des versions de la liste Remote Config.
ListeVersionsRésultat Interface représentant une liste des versions du modèle Remote Config.
Condition de configuration à distance Interface représentant une condition de configuration à distance. Une condition cible un groupe spécifique d’utilisateurs. Une liste de ces conditions fait partie d’un modèle Remote Config.
Paramètre de configuration à distance Interface représentant un paramètre Remote Config. Au minimum, une entrée defaultValue ou conditionalValues ​​doit être présente pour que le paramètre ait un effet.
Groupe de paramètres de configuration distante Interface représentant un groupe de paramètres Remote Config. Le regroupement des paramètres est uniquement destiné à des fins de gestion et n’affecte pas la récupération des valeurs de paramètres côté client.
Modèle de configuration distant Interface représentant un modèle Remote Config.
Utilisateur de configuration distant Interface représentant un utilisateur Remote Config.
Version Interface représentant une version du modèle Remote Config. Sortie uniquement, à l'exception de la description de la version. Contient des métadonnées sur une version particulière du modèle Remote Config. Tous les champs sont définis au moment de la publication du modèle Remote Config spécifié. Le champ de description d'une version peut être spécifié dans les appels publishTemplate .

Tapez les alias

Tapez l'alias Description
ParamètreValueType Type représentant un type de données de valeur de paramètre Remote Config. La valeur par défaut est STRING si elle n'est pas spécifiée.
Valeur du paramètre RemoteConfig Type représentant une valeur de paramètre Remote Config. Un RemoteConfigParameterValue peut être un ExplicitParameterValue ou un InAppDefaultValue .
CouleurÉtiquette Couleurs associées à des conditions à des fins d'affichage.

getRemoteConfig()

Obtient le service RemoteConfig pour l'application par défaut ou une application donnée.

getRemoteConfig() peut être appelé sans argument pour accéder au service RemoteConfig de l'application par défaut ou en tant que getRemoteConfig(app) pour accéder au service RemoteConfig associé à une application spécifique.

Signature:

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

Paramètres

Paramètre Taper Description
application Application Application facultative pour laquelle renvoyer le service RemoteConfig . S’il n’est pas fourni, le service RemoteConfig par défaut est renvoyé.

Retour:

Configuration à distance

Le service RemoteConfig par défaut si aucune application n'est fournie, ou le service RemoteConfig associé à l'application fournie.

Exemple 1

// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();

Exemple 2

// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);

ParamètreValueType

Type représentant un type de données de valeur de paramètre Remote Config. La valeur par défaut est STRING si elle n'est pas spécifiée.

Signature:

export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';

Valeur du paramètre RemoteConfig

Type représentant une valeur de paramètre Remote Config. Un RemoteConfigParameterValue peut être soit un ExplicitParameterValue , soit un InAppDefaultValue .

Signature:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

CouleurÉtiquette

Couleurs associées à des conditions à des fins d'affichage.

Signature:

export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';