You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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

getAccessToken()


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

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

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

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

ТипОписание
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 текущего пользователя.

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

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

Пример:

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

getPreference(preferenceName)


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

Параметры:

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

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

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

Пример:

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

hasRole(role)


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

Параметры:

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

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

ТипОписание
Boolean

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

Пример:

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

setPreference(preferenceName, value)


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

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

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

Параметры:

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

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

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

Пример:

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

  • No labels