getGlobalContext.userSettings (クライアント API 参照)

getGlobalContext.userSettings オブジェクトは、セキュリティ ロール、言語、タイム ゾーンなど、モデル駆動型アプリの現在のユーザー設定に関する情報を返します。

var userSettings = Xrm.Utility.getGlobalContext().userSettings

プロパティ

userSettings オブジェクトは以下のプロパティを持ちます:

件名 タイプ プロパティ
dateFormattingInfo dateFormattingInfo 現在のユーザーの日付の書式設定情報を返します。
defaultDashboardId 文字列 現在のユーザーの既定のダッシュボードの ID を返します。
isGuidedHelpEnabled ブール値 ガイド付きヘルプが現在のユーザーに対して有効になっているかどうか。
isHighContrastEnabled ブール値 ハイ コントラストが現在のユーザーに対して有効になっているかどうか。
isRTL ブール値 現在のユーザーの言語が右から左 (RTL) の言語かどうか。
languageId number 現在のユーザーの言語コードを返します。
roles roles ユーザーに割り当てられた各セキュリティ ロールの GUID と表示名、およびユーザーが関連付けられているチームに割り当てられたセキュリティ ロールを含むルックアップ オブジェクトのコレクション。
securityRolePrivileges string[] ユーザーが関連付けられているセキュリティ ロールの特権、またはユーザーが割り当てられているチームのそれぞれの GUID 値を表す文字列の配列。
securityRoles string[] 廃止されました。 roles プロパティを使用します。
transactionCurrency transactionCurrency 現在のユーザーのトランザクション通貨。
transactionCurrencyId 文字列 廃止されました。 transactionCurrency プロパティを使用します
userId 文字列 現在のユーザーの systemuser.systemuserid 値の GUID を返します。
userName 文字列 現在のユーザー名。

dateFormattingInfo

日付形式に関する文字列プロパティを持つオブジェクトは、FirstDayOfWeek、LongDatePattern、 MonthDayPattern、TimeSeparatorなどです。

roles

ユーザーが関連付けられている各セキュリティロールまたはチームの id および name を含むオブジェクト。

このプロパティは、統一インターフェイスでのみサポートされます。

transactionCurrency

このプロパティは、統一インターフェイスでのみサポートされます。

Currency (TransactionCurrency) レコードへの参照。 次に示すのはデータの例です。

{id: "e7dd9bc6-d239-ea11-a813-000d3a35b14a", entityType: "transactioncurrency", name: "US Dollar"}

トランザクション通貨の詳細

メソッド

userSettings オブジェクトには次のメソッドがあります。

Method description
getSecurityRolePrivilegesInfo 特権名、部署、アクセスの深さを取得して、現在のユーザーのセキュリティ ロール特権を検査します。
getTimeZoneOffsetMinutes 現在のユーザーのタイム ゾーン オフセットを分単位で取得して、現地時刻と UTC の差を計算します。

getSecurityRolePrivilegesInfo メソッド

セキュリティ ロール権限の GUID をキーとし、セキュリティロール権限の businessUnitId、depth、privilegeName を含むオブジェクトを値とするオブジェクトで解決されるプロミスを返します。

構文

userSettings.getSecurityRolePrivilegesInfo().then(successCallback, errorCallback);

Parameters

件名 タイプ Required プロパティ
successCallback Function いいえ セキュリティ ロール特権情報が取得されたときに呼び出す関数です。 ディクショナリは成功コールバックに渡され、セキュリティ ロール特権 GUID がキーになり、値は次のプロパティを含むオブジェクトになります:
id: 文字列。 セキュリティ ロール 特権 GUID。
businessUnitId: 文字列。 セキュリティ ロール特権の部署の GUID です。
privilegeName: 文字列。 セキュリティ ロール 特権 の名前です。
depth: 文字列。 セキュリティ ロール 特権 の深さです。
errorCallback Function いいえ 処理が失敗したときに呼び出す関数。 次のプロパティを持つオブジェクトが渡されます。
errorCode: 数。 エラー コード。
message: 文字列。 問題を示すエラー メッセージが表示されます。

戻り値

タイプ: Promise<{[key: string]: {id: string, businessUnitId: string, privilegeName: string, depth: number}}>

成功時に、上記 successCallback パラメーターの説明で指定済みの値を含む promise オブジェクトを戻します。

説明: GUID と、各セキュリティ ロール特権の部署や特権名などの追加の詳細です。

getSecurityRolePrivilegesInfo 例

userSettings
  .getSecurityRolePrivilegesInfo()
  .then(function success(rolePrivileges) {
    var privilegeGuids = Object.keys(rolePrivileges);
    console.log("Privileges Count: " + privilegeGuids.length);

    // Print information about the first role privilege in the dictionary
    var guid = privilegeGuids[0];
    console.log("Privilege Id: " + rolePrivileges[guid].id);
    console.log("Privilege Name: " + rolePrivileges[guid].privilegeName);
    console.log("Privilege Business Unit Id: " + rolePrivileges[guid].businessUnitId);
    console.log("Privilege depth: " + rolePrivileges[guid].depth);
  });

getTimeZoneOffsetMinutes メソッド

ローカル時間と標準の協定世界時 (UTC) との時差 (分単位) を返します。

構文

userSettings.getTimeZoneOffsetMinutes()

戻り値

種類: 数値

説明: タイム ゾーンのオフセット (分単位)。

クライアント コンテキスト
組織の設定
Xrm.Utility.getGlobalContext
ユーザー設定 (UserSettings) テーブル

  • 最終更新: