getGlobalContext.userSettings (クライアント API 参照)
現在のユーザー設定に関する情報を返します。
var userSettings = Xrm.Utility.getGlobalContext().userSettings
userSettings オブジェクトには以下のプロパティとメソッドがあります。
dateFormattingInfo
現在のユーザーの日付の書式設定情報を返します。
構文
userSettings.dateFormattingInfo
戻り値
種類: オブジェクト
説明: FirstDayOfWeek、LongDatePattern、MonthDayPattern、TimeSeparator などの日付の書式設定情報を持つオブジェクト。
defaultDashboardId
現在のユーザーの既定のダッシュボードの ID を返します。
構文
userSettings.defaultDashboardId
戻り値
種類: 文字列
説明: 既定のダッシュボードの ID。
isGuidedHelpEnabled
ガイド付きヘルプが現在のユーザーに対して有効になっているかどうかを示します。
構文
userSettings.isGuidedHelpEnabled
戻り値
種類: ブール値
説明: 有効な場合は true、そうでない場合は false です。
isHighContrastEnabled
ハイ コントラストが現在のユーザーに対して有効になっているかどうかを示します。
構文
userSettings.isHighContrastEnabled
戻り値
種類: ブール値
説明: 有効な場合は true、そうでない場合は false です。
isRTL
現在のユーザーの言語が右から左 (RTL) の言語かどうかを示します。
構文
userSettings.isRTL
戻り値
種類: ブール値
説明: RTL の場合は true、それ以外の場合は false です。
languageId
現在のユーザーの言語 ID を返します。
構文
userSettings.languageId
戻り値
種類: 数値
説明: 言語 ID。
ロール
ユーザーに割り当てられているセキュリティ ロールと、ユーザーが所属するチームに割り当てられているセキュリティ ロールのそれぞれの GUID と表示名を含むルックアップ オブジェクトのコレクションを返します。 このメソッドは、統一インターフェイス上でのみサポートされます。
構文
userSettings.roles
戻り値
種類: コレクション
説明: ユーザーが関連付けられている各セキュリティロールまたはチームの id
および name
を含むオブジェクト。
securityRolePrivileges
ユーザーが関連付けられているセキュリティ ロールの特権、またはユーザーが割り当てられているチームのそれぞれの GUID 値を表す文字列の配列を返します。
注意
この API は、Dynamics 365 Customer Engagement の設置型展開に利用できません。 詳細: クライアント API は Customer Engagement (on-premises) でサポートされていません
構文
userSettings.securityRolePrivileges
戻り値
種類: 配列
説明: それぞれのセキュリティ ロールの特権の GUID 値。
getSecurityRolePrivilegesInfo()
セキュリティ ロール権限の GUID をキーとし、セキュリティロール権限の businessUnitId
、depth
、privilegeName
を含むオブジェクトを値とするオブジェクトで解決されるプロミスを返します。
構文
userSettings.getSecurityRolePrivilegesInfo().then(successCallback, errorCallback);
Parameters
件名 | タイプ | Required | Description |
---|---|---|---|
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 と、各セキュリティ ロール特権の部署や特権名などの追加の詳細です。
例
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);
});
securityRoles
ユーザーが関連付けられている各セキュリティ ロールまたはチームの GUID 値を表す文字列の配列を返します。
非推奨; 代わりにuserSettings.roles を使用して、ID とともにセキュリティ ロールまたはチームの表示名を表示します。
構文
userSettings.securityRoles
戻り値
種類: 配列
説明: それぞれのセキュリティ ロールの GUID 値。 たとえば、次のようなものです。
["0d3dd20a-17a6-e711-a94e-000d3a1a7a9b", "ff42d20a-17a6-e711-a94e-000d3a1a7a9b"]
transactionCurrency
現在のユーザーの取引通貨の ID、表示名、およびテーブルの種類を含む検索オブジェクトを返します。 このメソッドは、統一インターフェイス上でのみサポートされます。
構文
userSettings.transactionCurrency
戻り値
種類: 検索オブジェクト
説明: 取引通貨の id
、name
、および entityType
を含むオブジェクト。 たとえば、次のようなものです。
{id: "e7dd9bc6-d239-ea11-a813-000d3a35b14a", entityType: "transactioncurrency", name: "US Dollar"}
transactionCurrencyId
現在のユーザーの取引通貨 ID を返します。
非推奨; 代わりに、userSettings.transactionCurrency を使用して ID と共に表示名にアクセスします。
構文
userSettings.transactionCurrencyId
戻り値
種類: 文字列
説明: 取引通貨の ID。
userId
現在のユーザーの SystemUser.Id 値の GUID を返します。
構文
userSettings.userId
戻り値
種類: 文字列
説明: ユーザーの ID。 たとえば、次のようになります。
"{75B5BA27-FD41-4D45-8E3A-C8446C95F0CC}"
userName
現在のユーザー名を返します。
構文
userSettings.userName
戻り値
種類: 文字列
説明: 現在のユーザーの名前。
getTimeZoneOffsetMinutes メソッド
ローカル時間と標準の協定世界時 (UTC) との時差 (分単位) を返します。
構文
userSettings.getTimeZoneOffsetMinutes()
戻り値
種類: 数値
説明: タイム ゾーンのオフセット (分単位)。
関連記事
クライアント コンテキスト
組織の設定
Xrm.Utility.getGlobalContext
注意
ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)
この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。