クライアント API を使用して設定値を取得または更新する

  • [アーティクル]

設定は、開発者がアプリをすばやく構成して、カスタマイズされたエクスペリエンスを提供できるようにするソリューション コンポーネントです。 設定を使用して、機能を有効または無効にしたり、環境内の 1 つのアプリまたはすべてのアプリの機能の動作を構成したりできます。 詳細: 設定を使用してカスタマイズされたアプリ エクスペリエンスを提供する

次の関数は、クライアント API を使用して設定値を取得または更新するために使用できます。

getCurrentAppSetting

現在のアプリの設定値を取得します。

構文

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

Parameters

件名 タイプ Required Description
settingName 文字列 はい 値を取得する設定の名前。

値を返す

型: 設定の型と同じ: 数値、文字列、または はい/いいえ

説明:

  • 設定が 上書き可能 な場合:

    • 値は上書き可能 が 環境とアプリ に設定されている場合は、設定アプリの値が返されます。

      • 設定のアプリの値が存在しない場合は、設定環境の値が返されます。
      • 設定環境の値が存在しない場合は、設定定義で指定した既定値が返されます。

    • 値は上書き可能 が 環境のみ に設定されている場合は、設定環境の値が返されます。

      • 設定環境の値が存在しない場合は、設定定義で指定した既定値が返されます。

    • 値は上書き可能 が アプリのみ に設定されている場合は、設定アプリの値が返されます。

      • 設定アプリの値が存在しない場合は、設定定義で指定した既定値が返されます。

  • 設定が オーバーライド でない場合は、設定定義で指定した既定値が返されます。

  • 設定名が正しくないか、設定が見つからなかった場合、戻り値は null になります。

saveSettingValue

現在のアプリの設定アプリの値または現在の環境の設定環境の値を追加または更新します。

構文

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);

Parameters

件名 タイプ Required Description
settingName 文字列 はい 値を更新する設定の名前。
value 数値、文字列、または はい/いいえ はい 設定を更新する値。
saveSettingOptions 文字列 いいえ 値を更新するときのオプション。 これには 2 つのパラメーターが含まれています
  • overrideScope
    • 1 を使用して設定環境の値を追加または更新します
    • 2 を使用して設定アプリの値を追加または更新します。
    • 指定しない場合は、環境に設定されます。
  • solutionUniqueName
    • 設定環境の値または設定アプリの値を追加する必要があるソリューション。
    • 指定しない場合は、既定のソリューションが使用されます。
successCallback 文字列 はい 更新が成功した場合に呼び出す関数。
errorCallback 文字列 はい 更新が失敗した場合に呼び出す関数。

値を返す

成功すると、promise オブジェクトを返します。

Web API

次の Web API を使用して、設定値を取得または更新することもできます

ソリューションの概要
設定を使用してカスタマイズされたアプリ エクスペリエンスを提供します。