Partager via


Obtenir ou mettre à jour une valeur du paramètre à l’aide de l’API client

Les paramètres sont des composants de solution qui permettent aux développeurs de configurer rapidement des applications pour offrir une expérience personnalisée. Les paramètres peuvent être utilisés pour activer ou désactiver des fonctionnalités ou configurer le comportement des fonctionnalités pour une seule application ou toutes les applications d’un environnement. Plus d’informations : Utiliser les paramètres pour fournir des expériences d’application personnalisées

Les fonctions suivantes peuvent être utilisées pour obtenir ou mettre à jour une valeur de paramètre à l’aide de l’API client.

getCurrentAppSetting

Obtient la valeur d’un paramètre pour l’application actuelle.

Syntaxe

var settingValue = Xrm.Utility.getGlobalContext().getCurrentAppSetting(settingName);

Paramètres

Nom Type Requise Description
settingName String Oui Le nom du paramètre pour lequel obtenir la valeur.

Valeur renvoyée

Type : identique au type de paramètre : Nombre, Chaîne ou Oui/Non

Description :

  • Si le réglage est Remplaçable :

    • Si l’option La valeur peut être remplacée est définie sur Environnement et application, la valeur de l’application de paramètre est renvoyée.

      • Si une valeur d’application de paramètre n’existe pas, la valeur d’environnement de paramètre est renvoyée.
      • Si une valeur d’environnement de paramètre n’existe pas, la valeur par défaut spécifiée dans la définition de paramètre est renvoyée.
    • Si l’option La valeur peut être remplacée est définie sur Environnement uniquement, la valeur de l’environnement de paramètre est renvoyée.

      • Si une valeur d’environnement de paramètre n’existe pas, la valeur par défaut spécifiée dans la définition de paramètre est renvoyée.
    • Si l’option La valeur peut être remplacée est définie sur Application uniquement, la valeur de l’application de paramètre est renvoyée.

      • Si une valeur d’application de paramètre n’existe pas, la valeur par défaut spécifiée dans la définition de paramètre est renvoyée.
  • Si le paramètre n’est pas Écrasable, la valeur par défaut spécifiée dans la définition de paramètre est renvoyée.

  • Si le nom du paramètre est incorrect ou si le paramètre est introuvable, la valeur de retour est null.

saveSettingValue

Ajoute ou met à jour la valeur d’application de paramètre pour l’application actuelle ou la valeur d’environnement de paramètre pour l’environnement actuel.

Syntaxe

var appOverrideScope = 2; // Add or update a setting app value
var saveSettingOptions = {overrideScope: appOverrideScope, solutionUniqueName: mySolutionName};
Xrm.Utility.getGlobalContext().saveSettingValue(settingName, value, saveSettingOptions).then(successCallback, errorCallback);

Paramètres

Nom Type Requise Description
settingName String Oui Le nom du paramètre pour lequel mettre à jour la valeur.
value Nombre, Chaîne ou Oui/Non Oui Valeur du paramètre à mettre à jour.
saveSettingOptions String Non Options lors de la mise à jour de la valeur. Il contient deux paramètres
  • overrideScope
    • Utiliser 1 pour ajouter ou mettre à jour une valeur d’environnement de paramètre
    • Utiliser 2 pour ajouter ou mettre à jour une valeur d’application de paramètre.
    • S’il n’est pas spécifié, il est défini sur environnement.
  • solutionUniqueName
    • La solution à laquelle la valeur de l’environnement de paramètre ou la valeur de l’application de paramètre doivent être ajoutées.
    • Si non spécifiée, la solution par défaut est utilisée.
successCallback String Oui Une fonction à appeler si la mise à jour est réussie.
errorCallback String Oui Fonction à appeler si la mise à jour échoue.

Valeur renvoyée

En cas de succès, renvoie un objet promise.

API Web

Vous pouvez également utiliser les API Web suivantes pour obtenir ou mettre à jour une valeur de paramètre

Présentation des solutions
Utilisez les paramètres pour fournir des expériences d’application personnalisées