Перейти к основному содержимому
Версия: 1.21.3

SimpleUser

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

Свойства

s_user.accessToken


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

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

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

Пример:

s_user.accessToken
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Возвращает имя текущего пользователя.

Пример:

s_user.firstName
console.log(s_user.firstName);
//Иван

s_user.lastName


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

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

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

Пример:

s_user.lastName
console.log(s_user.lastName);
//Иванов

s_user.userID


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

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

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

Пример:

s_user.userID
const currentCaller = new SimpleRecord(s_user.user.essence);
currentCaller.get(s_user.userID, ()=> {
s_form.setValue('email', currentCaller.email);
});

s_user.user


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

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

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

Пример:

s_user.user
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Возвращает логин текущего пользователя.

Пример:

s_user.userName
console.log(s_user.userName);
//"admin"

Методы

s_user.getFullName()


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

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

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

s_user.getPreference(name)


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

внимание

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

Параметры:

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

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

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

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

Пример:

getPreference (String type)
const getMyPreference = async () => {
const response = await s_user.getPreference('preference_name');
};
getPreference (Array type)
const getMyPreference = async () => {
const response = await s_user.getPreference(['preference_name', 'preference2_name']);
};

s_user.setPreference(name, value)


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

внимание

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

Параметры:

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

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

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

Пример:

setPreference()
const setMyPreference = async () => {
const response = await s_user.setPreference('menu.tab', 1);
};