SimpleUser
Данный класс предоставляет методы и свойства для взаимодействия с информацией о текущем пользователе. Доступ к информации о пользователе осуществляется быстрее при помощи запросов SimpleUser API, чем SimpleRecord.
Свойства
s_user.accessToken
Используйте это свойство, чтобы получить токен доступа текущего пользователя.
Возвращаемое значение:
Тип | Описание |
---|---|
String | Возвращает токен доступа текущего пользователя. |
Пример:
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 | Возвращает имя текущего пользователя. |
Пример:
console.log(s_user.firstName);
//Иван
s_user.lastName
Используйте данное свойство, чтобы вернуть фамилию текущего пользователя.
Возвращаемое значение:
Тип | Описание |
---|---|
String | Возвращает фамилию текущего пользователя. |
Пример:
console.log(s_user.lastName);
//Иванов
s_user.userID
Используйте данное свойство, чтобы получить ID текущего пользователя.
Возвращаемое значение:
Тип | Описание |
---|---|
String | Возвращает значение ID текущего пользователя. |
Пример:
const currentCaller = new SimpleRecord(s_user.user.essence);
currentCaller.get(s_user.userID, ()=> {
s_form.setValue('email', currentCaller.email);
});
s_user.user
Используйте данное свойство, чтобы получить объект с данными о текущем пользователе, такими как имя, фамилия, значение ID и другими.
Возвращаемое значение:
Тип | Описание |
---|---|
Object | Возвращает объект с информацией о пользователе. |
Пример:
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 | Возвращает логин текущего пользователя. |
Пример:
console.log(s_user.userName);
//"admin"
Методы
s_user.getFullName()
Используйте этот метод, чтобы получить полное имя текущего пользователя (значения полей Имя и Фамилия).
Возвращаемое значение:
Тип | Описание |
---|---|
String | Метод возвращает имя и фамилию текущего пользователя. |
s_user.getPreference(name)
Используйте этот метод, чтобы получить указанные значения настроек для текущего пользователя.
Метод является асинхронным. Для оптимальной работы используйте ключевое слово await, как в примере ниже.
Параметры:
Наименование | Тип | Обязательно | Значение по умолчанию |
---|---|---|---|
name | Array of Strings | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Object | Метод возвращает объект Promise, содержащий массив строк. |
Строкой можно передать название только одной пользовательской настройки. Для того чтобы передать названия большего количества настроек, используйте тип Array, как показано ниже.
Пример:
const getMyPreference = async () => {
const response = await s_user.getPreference('preference_name');
};
const getMyPreference = async () => {
const response = await s_user.getPreference(['preference_name', 'preference2_name']);
};
s_user.setPreference(name, value)
Используйте данный метод, чтобы установить значение указанной настройки для текущего пользователя. Для того чтобы получить ранее заданное значение настройки, используйте метод s_user.getPreference(name).
Метод является асинхронным. Для оптимальной работы используйте ключевое слово await, как в примере ниже.
Параметры:
Наименование | Т ип | Обязательно | Значение по умолчанию |
---|---|---|---|
name | String | Да | Нет |
value | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Object | Метод возвращает объект Promise, содержащий данные. |
Пример:
const setMyPreference = async () => {
const response = await s_user.setPreference('menu.tab', 1);
};