SimpleUser Server-Side

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

getAccessToken()

---

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

Пустая строка возвращается в следующих случаях:

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

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

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

Пример:

getAccessToken()

const user = new SimpleUser();
ss.info(user.getAccessToken());
// Информация: PV8wLSJWEJONyvF87aIQn2b--7EMEhy_

getContext()

---

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

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

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

Пример:

getContext()

const user = new SimpleUser();
ss.info(user.getContext().username);
// Информация: admin

getID()

---

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

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

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

Пример:

getID()

const user = new SimpleUser();
ss.info(user.getID());
// Информация: 155931135900000099

getPreference(preferenceName)

---

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

Параметры:

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

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

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

Пример:

getPreference()

const user = new SimpleUser();
ss.info(user.getPreference('application'));
// Информация: 155931135900000002

hasRole(role)

---

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

Параметры:

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

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

Тип	Описание
Boolean	Метод возвращает значение true, если у пользователя есть указанная роль или роль admin; если нет, метод возвращает значение false.

Пример:

hasRole()

const user = new SimpleUser();
ss.info(user.hasRole('service_owner'));
// Информация: false

setPreference(preferenceName, value)

---

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

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

предупреждение

Значение параметра value не может быть длиннее 255 символов.

Параметры:

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

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

Тип	Описание
Void	Метод не возвращает значение.

Пример:

setPreference()

const user = new SimpleUser();
user.setPreference('language', 'en');
ss.info(user.getPreference('language'));
// Информация: en