getGlobalContext.userSettings (довідник з API клієнта)

Повертає відомості про поточні настройки користувача.

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

Властивості

Об'єкт userSettings має такі властивості:

Ім'я Тип Опис
dateFormattingInfo об'єкт Повертає відомості про форматування дати для поточного користувача. Див . dateFormattingInfo
defaultDashboardId рядок Повертає ідентифікатор приладної дошки за промовчанням для поточного користувача.
isGuidedHelpEnabled логічний Чи ввімкнуто інтерактивну довідку для поточного користувача.
isHighContrastEnabled логічний Чи ввімкнуто високу контрастність для поточного користувача.
isRTL логічний Чи є мова поточного користувача мовою з письма справа наліво (RTL).
languageId число Код мови LCID для поточного користувача.
roles колекція Колекція об'єктів підстановки, що містять GUID і коротке ім'я кожної ролі безпеки, призначеної користувачу, і будь-які ролі безпеки, призначені команді, з якою пов'язано користувача. Переглянути ролі
securityRolePrivileges рядок[] масив рядків, які представляють значення GUID кожного з прав ролі безпеки, з якими пов'язано користувача, або будь-яких команд, з якими пов'язано користувача.
securityRoles рядок[] Застаріло. Скористайтеся властивістю roles .
transactionCurrency об'єкт Об'єкт, idщо містить , nameі entityType грошову одиницю транзакції для поточного користувача. Див . transactionCurrency
transactionCurrencyId рядок Застаріло. Використовувати властивість transactionCurrency
userId рядок Значення systemuser.systemuserid поточного користувача.
userName рядок Ім'я поточного користувача.

dateFormattingInfo

Об'єкт із властивостями рядка про форматування дати, наприклад FirstDayOfWeek, LongDatePattern, MonthDayPattern, TimeSeparator, тощо.

Ролі

Колекція містить об'єкти та idname властивості для кожної з ролей безпеки або команд, з якими пов'язано користувача.

Ця властивість підтримується лише в єдиному інтерфейсі.

transactionCurrency

Цей метод підтримується лише в єдиному інтерфейсі.

Дані можуть виглядати приблизно так:

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

Методи

Об'єкт userSettings має такі методи:

метод getSecurityRolePrivilegesInfo

Повертає обіцянку, яка розпізнається з об'єктом, ключами якого є права на роль безпеки GUID, а значення – це об'єкти, які містять businessUnitIddepth, і privilegeName права ролі безпеки.

Синтаксис

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

Параметри

Ім'я Тип Необхідний Опис
successCallback Function Ні Функція, яку потрібно викликати під час отримання відомостей про права на роль безпеки. Словник буде передано до зворотного виклику успішного завершення, де guids ролі безпеки будуть ключами, а значення – об'єктами, які містять такі властивості:
id:Рядок. GUID прав для ролі безпеки.
businessUnitId:Рядок. GUID підрозділу права ролі безпеки.
privilegeName:Рядок. Ім'я права ролі безпеки.
depth:Рядок. Глибина прав для ролі безпеки.
errorCallback Function Ні Функція для виклику, коли операція не вдається. Буде передано об'єкт з наступними властивостями:
errorCode:Число. Код помилки.
message:Рядок. Повідомлення про помилку з описом проблеми.

Повернуте значення

Тип: Promise<{[key: string]: {id: string, businessUnitId: string, privilegeName: string, depth: number}}>

Після успішного виконання повертає об'єкт обіцянки, що містить значення, указані в описі параметра successCallback вище.

Опис: GUID та додаткові відомості, як-ось підрозділ і ім'я права кожного з прав ролі безпеки.

getSecurityRolePrivilegesInfo example

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)