Einen Einstellungswert mithilfe der Client-API abrufen oder aktualisieren
Einstellungen sind Lösungskomponenten, die es Entwicklern ermöglichen, Apps schnell zu konfigurieren, um eine benutzerdefinierte Erfahrung bereitzustellen. Einstellungen können verwendet werden, um Funktionen zu aktivieren oder zu deaktivieren oder das Funktionsverhalten für eine einzelne App oder alle Apps in einer Umgebung zu konfigurieren. Weitere Informationen: Nutzen der Einstellungen, um angepasste Apps anzubieten
Die folgenden Funktionen können verwendet werden, um einen Einstellungswert mithilfe der Client-API abzurufen oder zu aktualisieren.
getCurrentAppSetting
Ruft den Wert für eine Einstellung der aktuellen App ab.
Syntax
var settingValue = Xrm.Utility.getGlobalContext().getCurrentAppSetting(settingName);
Parameter
Name des Dataflows | Type | Erforderlich | Beschreibung |
---|---|---|---|
settingName |
String | Ja | Der Name der Einstellung, für die der Wert abgerufen werden soll. |
Zurückgegebener Wert
Typ: Identisch mit dem Typ der Einstellung: Nummer, Zeichenfolge oder Ja/Nein
Beschreibung:
Wenn die Einstellung Überschreibbar lautet:
Wenn Wert kann überschrieben auf Umgebung und App eingestellt ist, wird der Einstellungs-App-Wert zurückgegeben.
- Wenn kein Einstellungs-App-Wert vorhanden ist, wird der Einstellungsumgebungswert zurückgegeben.
- Wenn kein Einstellungsumgebungswert vorhanden ist, wird der in der Einstellungsdefinition angegebene Standardwert zurückgegeben.
Wenn Wert kann überschrieben auf Nur Umgebung eingestellt ist, wird der Einstellungsumgebungswert zurückgegeben.
- Wenn kein Einstellungsumgebungswert vorhanden ist, wird der in der Einstellungsdefinition angegebene Standardwert zurückgegeben.
Wenn Wert kann überschrieben auf Nur App eingestellt ist, wird der Einstellungs-App-Wert zurückgegeben.
- Wenn kein App-Wert vorhanden ist, wird der in der Einstellungsdefinition angegebene Standardwert zurückgegeben.
Wenn die Einstellung nicht Überschreibbar lautet, wird der in der Einstellungsdefinition angegebene Standardwert zurückgegeben.
Wenn der Einstellungsname falsch ist oder die Einstellung nicht gefunden werden kann, ist der Rückgabewert null.
saveSettingValue
Fügt den Einstellungs-App-Wert für die aktuelle App oder den Einstellungsumgebungswert für die aktuelle Umgebung hinzu oder aktualisiert ihn.
Syntax
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);
Parameter
Name des Dataflows | Type | Erforderlich | Beschreibung |
---|---|---|---|
settingName |
String | Ja | Der Name der Einstellung, deren Wert aktualisiert werden soll. |
value |
Nummer, Zeichenfolge oder Ja/Nein | Ja | Die Wert, auf den die Einstellung aktualisiert werden soll. |
saveSettingOptions |
String | Nein | Optionen beim Aktualisieren des Wertes. Enthält zwei Parameter
|
successCallback |
String | Ja | Eine Funktion, die aufgerufen wird, wenn das Update erfolgreich ist. |
errorCallback |
String | Ja | Eine Funktion zum Aufrufen, wenn das Aktualisieren fehlschlägt. |
Zurückgegebener Wert
Gibt bei Erfolg ein Promise-Objekt zurück.
Web-APIs
Sie können auch die folgenden Web-APIs verwenden, um einen Einstellungswert abzurufen oder zu aktualisieren
Ähnliche Artikel
Überblick über Lösungen
Verwenden Sie die Einstellungen, um angepasste App-Erlebnisse zu schaffen