getGlobalContext.userSettings (客户端 API 参考)

返回有关当前用户设置的信息。

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

属性

userSettings 对象具有以下属性:

Name 类型 Description
dateFormattingInfo 对象 返回当前用户的日期格式信息。 请参阅 dateFormattingInfo
defaultDashboardId 字符串 返回当前用户的默认仪表板的 ID。
isGuidedHelpEnabled 布尔 是否为当前用户启用了引导帮助。
isHighContrastEnabled 布尔 是否为当前用户启用高对比度。
isRTL 布尔 当前用户的语言是否为从右到左(RTL)语言。
languageId 数字 当前用户的 LCID 语言代码
roles 收藏 查找对象的集合,其中包含分配给用户的每个安全角色的 GUID 和显示名称,以及分配给该用户与之关联的团队的任何安全角色。 查看 角色
securityRolePrivileges 字符串[] 一个字符串数组,表示用户与该用户关联的每个安全角色特权的 GUID 值或用户与之关联的任何团队的 GUID 值。
securityRoles 字符串[] 已弃用。 使用属性 roles
transactionCurrency 对象 包含 id当前用户的事务 name货币和 entityType 事务货币的对象。 请参阅 transactionCurrency
transactionCurrencyId 字符串 已弃用。 使用 transactionCurrency 属性
userId 字符串 当前用户的 systemuser.systemuserid 值。
userName 字符串 当前用户的名称。

dateFormattingInfo

一个对象,其中包含有关日期格式的字符串属性,例如FirstDayOfWeekLongDatePatternMonthDayPatternTimeSeparator,等等。

roles

该集合包含用户与之关联的每个安全角色或团队的对象 idname 属性。

此属性仅在统一接口上受支持。

transactionCurrency

此方法仅在统一接口上受支持。

数据可能如下所示:

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

Methods

userSettings 对象具有以下方法:

getSecurityRolePrivilegesInfo 方法

返回一个承诺,该承诺使用其密钥是安全角色特权 GUID 的对象,而值是包含businessUnitIddepth安全角色特权的对象以及privilegeName安全角色特权的对象。

Syntax

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

参数

Name 类型 必选 Description
successCallback 功能 检索安全角色特权信息时要调用的函数。 字典将传递给成功回调,其中安全角色特权 GUID 将是密钥,值将是包含以下属性的对象:
id:字符串。 安全角色特权 GUID。
businessUnitId:字符串。 安全角色特权业务部门的 GUID。
privilegeName:字符串。 安全角色特权名称。
depth:字符串。 安全角色特权深度。
errorCallback 功能 作失败时要调用的函数。 将传递具有以下属性的对象:
errorCode:数。 错误代码。
message:字符串。 描述问题的错误消息。

返回值

类型Promise<{[key: string]: {id: string, businessUnitId: string, privilegeName: string, depth: number}}>

成功后,返回一个 promise 对象,该对象包含上述 successCallback 参数说明中指定的值。

说明: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)之间的分钟差。

Syntax

userSettings.getTimeZoneOffsetMinutes()

返回值

类型:数字

说明:时区偏移量(以分钟为单位)。

客户端上下文
组织设置
Xrm.Utility.getGlobalContext
用户设置 (UserSettings) 表