This server-side class allows to get information about the current user and his prerequisites, for example, assigned roles and preferences.
getAccessToken()
This method returns access token of the current user within the current session.
Return:
Type
Description
String
Method returns the current user access token. If it is not set, then an empty string is returned.
Example:
getAccessToken
const user = new SimpleUser();
ss.info(user.getAccessToken()); // Info: PV8wLSJWEJONyvF87aIQn2b--7EMEhy_
getContext()
This method allows to get current user information given the context (whether this is the system user or an employee having additional attributes against regular users).
Return:
Type
Description
SimpleRecord object
This method returns an object containing the current user information.
Example:
getContext
const user = new SimpleUser();
ss.info(user.getContext().username); // Info: admin
getID()
This method gets the current user ID.
Return:
Type
Description
String
Current user ID.
getID
const user = new SimpleUser();
ss.info(user.getID()); // Info: 155931135900000099
getPreference(preferenceName)
This method allows to get a value of the specified User Preference for the current user.
Parameter(s):
Name
Type
Mandatory
Default Value
preferenceName
String
Y
N
Return:
Type
Description
String
This method returns the specified preference value for the current user. If the specified preference does not exist, it returns 'null'.
getPreference
const user = new SimpleUser();
ss.info(user.getPreference('application')); // Info: 155931135900000002
hasRole(role)
This method allows to find out whether the current user is granted with a specified role or not. It always returnstrueif the current user has the admin role.
Parameter(s):
Name
Type
Mandatory
Default Value
role
String
Y
N
Return:
Type
Description
Boolean
This method returns 'true' if user is granted with a specified role; otherwise, it returns 'false'.
hasRole
const user = new SimpleUser();
ss.info(user.hasRole('service_owner')); // Info: false
setPreference(preferenceName, value)
This method allow to set a value for an existing or newly created User Preference for the current user.
Parameter(s):
Name
Type
Mandatory
Default Value
preferenceName
String
Y
N
value
String
Y
N
Return:
Type
Description
Void
This method does not return a value.
setPreference
const user = new SimpleUser();
user.setPreference('language', 'en');
ss.info(user.getPreference('language')); // Info: en