Этот серверный класс предназначен для получения информации о текущем пользователе и его персональных настройках, например, предпочтения пользователя или назначенные на него роли.
getAccessToken()
Метод возвращает токен доступа текущего пользователя в текущей сессии.
Пустая строка возвращается в следующих случаях:
вызов метода в рамках любой запланированной функциональности, например Scheduled Script
вызов этого метода другой функциональностью без прямого участия пользователя и сопутствующего запроса со стороны клиента.
Возвращаемое значение:
Тип
Описание
String
Метод возвращает токен доступа текущего пользователя. Если он не задан, метод возвращает пустую строку.
Пример:
getAccessToken
const user = new SimpleUser();
ss.info(user.getAccessToken()); // Инфо: PV8wLSJWEJONyvF87aIQn2b--7EMEhy_
getContext()
Используйте этот метод для получения информации о текущем пользователе с учетом контекста (имеет ли пользователь системы или сотрудник дополнительные атрибуты по сравнению с обычными пользователями).
Возвращаемое значение:
Тип
Описание
Объект SimpleRecord
Метод возвращает объект, содержащий информацию о текущем пользователе.
Пример:
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)
Используйте этот метод, чтобы определить, имеет ли текущий пользователь определенную роль. Метод всегда возвращает "true", если пользователю дана рольadmin.
Параметры:
Название
Тип
Обязательный
Значение по умолчанию
role
String
Да
Нет
Возвращаемое значение:
Тип
Описание
Boolean
Метод возвращает"true", если у пользователя есть указанная роль, если нет, метод возвращает значение "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