Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Данный класс предоставляет методы , которые возвращают информацию и свойства для взаимодействия с информацией о текущем пользователе. Доступ к информации о пользователе осуществляется быстрее при помощи запросов SimpleUser API, чем SimpleRecord.

Свойства

s_user.accessToken


Используйте данный методэто свойство, чтобы получить токен доступа текущего пользователя.

Возвращаемое значение:

ТипОписание
String
Токен
Возвращает токен доступа текущего пользователя.

Пример:

Code Block
languagejs
themeEclipse
titles_user.accessToken
linenumberstrue
const url = new URL(`${API_BASE_URL}/export/json/${s_list.getTablesName()[0]}`);
url.searchParams.set('access-token', s_user.accessToken);
url.searchParams.set('condition', s_list.getQuery());
window.open(url, "_blank");

s_user.firstName


Данный метод возвращает Используйте это свойство, чтобы вернуть имя текущего пользователя. 

Возвращаемое значение:

ТипОписание
String
Имя
Возвращает имя текущего пользователя.

Пример:

Code Block
languagejs
themeEclipse
titles_user.firstName
linenumberstrue
console.log(s_user.firstName);
//JohnИван

s_user.

getPreference(name)

lastName


Используйте этот методданное свойство, чтобы получить указанные значения преференций для вернуть фамилию текущего пользователя. 

Note

Это асинхронный метод. Для оптимальной работы используйте ключевое слово  async/await, как показано в примере ниже.

Параметр:

НазваниеТипОбязательныйЗначение по умолчаниюnameString или ArrayДН

Возвращаемое значение:

ТипОписание
ObjectЭтот метод возвращает promise object, содержащий определенные данные.
Info

Строкой можно передать название только одного предпочтения. В случае, если необходимо передать названия большего количества предпочтений, используйте тип Array, как показано ниже.

Пример:

Code BlocklanguagetitlegetPreference (
jsthemeEclipse
String
type)linenumberstrue
Возвращает
const getMyPreference = async () => {
    const response = await s_user.getPreference('preference_name');
};
Code Block
languagejs
themeEclipse
titlegetPreference (Array type)
linenumberstrue
const getMyPreference = async () => {
    const response = await s_user.getPreference(['preference_name', 'preference2_name']);
};

s_user.getFullName()

Используйте этот метод, чтобы получить полное имя текущего пользователя (значения полей Имя и Фамилия).

Возвращаемое значение:

ТипОписаниеStringИмя и фамилия текущего пользователя

s_user.lastName

Данный метод возвращает
фамилию текущего пользователя.

Возвращаемое значение:

ТипОписаниеStringФамилия текущего пользователя.

Пример:

Code Block
languagejs
themeEclipse
titles_user.lastName
linenumberstrue
console.log(s_user.lastName);
//DoeИванов

s_user.

setPreference(name, value)

Данный метод позволяет установить значение указанного предпочтения для текущего пользователя. Для того чтобы получить ранее заданное значение предпочтения, используйте метод s_user.getPreference(name).

Note

Это асинхронный метод. Для оптимальной работы используйте ключевое слово async/await, как показано в примере ниже.

Параметры:

НазваниеТипОбязательныйЗначение по умолчаниюnameStringДНvalueStringДН

Возвращаемое значение:

ТипОписаниеObjectМетод возвращает promise object, содержащий указанные данные.

userID


Используйте данное свойство

Пример:

Code Block
languagejs
themeEclipse
titlesetPreference
linenumberstrue
const setMyPreference = async () => {
    const response = await s_user.setPreference('menu.tab', 1);
};
// Promise {<pending>}
// [[PromiseState]]: "fulfilled"
// [[PromiseResult]]: Object

s_user.userID

Используйте данный метод, чтобы получить ID текущего пользователя.

Возвращаемое значение:

ТипОписание
String
Значение sys_id
Возвращает значение ID текущего пользователя.

Пример:

Code Block
languagejs
themeEclipse
titles_user.userID
linenumberstrue
const currentCaller = new SimpleRecord(s_user.user.essence);
currentCaller.get(s_user.userID, ()=> {
  s_form.setValue('email', currentCaller.email);
});

s_user.user


Данный метод позволяет получить данные Используйте данное свойство, чтобы получить объект с данными о текущем пользователе, такие такими как имя, фамилия, значение sys_id ID и другие. Метод возвращает SimpleRecord объект в формате JSON.другими. 

Возвращаемое значение:

ТипОписание
Объект SimpleRecordОбъект, содержащий информацию
ObjectВозвращает объект с информацией о пользователе.

Пример:

Code Block
languagejs
themeEclipse
titles_user.user
linenumberstrue
console.log(JSON.stringify(s_user.user, null, 2));
/*"{
  "sys_id": "155931135900000001",
  "first_name": "Admin",
  "last_name": "Admin",
  "username": "admin",
  "essence": "user",
  "timezone": "Europe/Moscow",
  "language": "en",
  "photo_path": null,
  "elevate_access": -1,
  "version": "1.3.6",
  "dictionary": {...},
  "impersonate_state": null
}"*/

s_user.userName


Данный метод позволяет Используйте данное свойство, чтобы получить логин (username) текущего пользователя (например, helpdesk.agent).

Возвращаемое значение:

ТипОписание
String
Логин
Возвращает логин текущего пользователя.

Пример:

Code Block
languagejs
themeEclipse
titles_user.userName
linenumberstrue
console.log(s_user.userName);
//"admin"

Методы

s_user.getFullName()


Используйте этот метод, чтобы получить полное имя текущего пользователя (значения полей Имя и Фамилия).

Возвращаемое значение:

ТипОписание
StringМетод возвращает имя и фамилию текущего пользователя.

s_user.getPreference(name)


Используйте этот метод, чтобы получить указанные значения настроек для текущего пользователя. 

Note

Метод является асинхронным. Для оптимальной работы используйте ключевое словоawait,как в примере ниже.

Параметр:

НазваниеТипОбязательныйЗначение по умолчанию
nameArray of StringsДаНет

Возвращаемое значение:

ТипОписание
ObjectМетод возвращает объект Promise, содержащий массив строк.


Info

Строкой можно передать название только одной пользовательской настройки. Для того чтобы передать названия большего количества настроек, используйте тип Array, как показано ниже.

Пример:

Code Block
languagejs
themeEclipse
titles_user.getFullName(getPreference (String type)
linenumberstrue
const commentValuegetMyPreference = async () => `${{
    const response = await s_user.getFullNamegetPreference('preference_name')}: "${s_form.getValue('comment')}"`;
s_form.setValue('additional_comment', commentValue);
};


Code Block
languagejs
themeEclipse
titlegetPreference (Array type)
linenumberstrue
const getMyPreference = async () => {
    const response = await s_user.getPreference(['preference_name', 'preference2_name']);
};

s_user.setPreference(name, value)


Используйте данный метод, чтобы установить значение указанной настройки для текущего пользователя. Для того чтобы получить ранее заданное значение настройки, используйте метод s_user.getPreference(name).

Note

Метод является асинхронным. Для оптимальной работы используйте ключевое словоawait,как в примере ниже.

Параметры:

НазваниеТипОбязательныйЗначение по умолчанию
nameStringДаНет
valueStringДаНет

Возвращаемое значение:

ТипОписание
ObjectМетод возвращает объект Promise, содержащий данные.

Пример:

Code Block
languagejs
themeEclipse
titlesetPreference
linenumberstrue
const setMyPreference = async () => {
    const response = await s_user.setPreference('menu.tab', 1);
};
;


Table of Contents
absoluteUrltrue
classfixedPosition
printablefalse