getGlobalContext.userSettings (クライアント API 参照)
現在のユーザー設定に関する情報を返します。
var userSettings = Xrm.Utility.getGlobalContext().userSettings
プロパティ
userSettings
オブジェクトには次のプロパティがあります。
件名 | タイプ | プロパティ |
---|---|---|
dateFormattingInfo |
オブジェクト | 現在のユーザーの日付の書式設定情報を返します。 dateFormattingInfoを参照してください |
defaultDashboardId |
string | 現在のユーザーの既定のダッシュボードの ID を返します。 |
isGuidedHelpEnabled |
ブール値 | 現在のユーザーに対してガイド付きヘルプが有効になっているかどうか。 |
isHighContrastEnabled |
ブール値 | 現在のユーザーに対して ハイ コントラスト が有効になっているかどうか。 |
isRTL |
ブール値 | 現在のユーザーの言語が右から左 (RTL) の言語であるかどうか。 |
languageId |
number | 現在のユーザーの LCID言語コード 。 |
roles |
収集 | ユーザーに割り当てられている各 セキュリティ ロール のGUIDと 表示名、およびユーザーが関連付けられているチームに割り当てられているセキュリティ ロールを含む参照オブジェクトのコレクション。 役割を見る |
securityRolePrivileges |
string[] | ユーザーが関連付けられている各 セキュリティ ロール 権限またはユーザーが関連付けられているチームのGUID値を表す文字列の配列。 |
securityRoles |
string[] | 廃止されました。 roles プロパティを使用します。 |
transactionCurrency |
オブジェクト | 現在のユーザーの取引通貨の id 、 name 、および entityType を含むオブジェクト。 トランザクション通貨を参照してください |
transactionCurrencyId |
string | 廃止されました。 transactionCurrency プロパティを使用する |
userId |
string | 現在のユーザーの systemuser.systemuserid 値。 |
userName |
string | 現在のユーザーの名前。 |
dateFormattingInfo
FirstDayOfWeek
、 LongDatePattern
、 MonthDayPattern
、 TimeSeparator
などの日付書式に関する文字列プロパティを持つオブジェクト。
roles
コレクションには、ユーザーが関連付けられているセキュリティ ロールまたはチームごとに、 id
および name
プロパティを持つオブジェクトが含まれています。
このプロパティは 統一インターフェイス でのみサポートされます。
transactionCurrency
このメソッドは、統一インターフェイス上でのみサポートされます。
データは次のようになります。
{id: "e7dd9bc6-d239-ea11-a813-000d3a35b14a", entityType: "transactioncurrency", name: "US Dollar"}
メソッド
userSettings
オブジェクトには次のメソッドがあります。
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と、ビジネス ユニットや権限名などの追加の詳細。
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) テーブル