SimpleUser

This class provides methods and properties for operating information about the current user. SimpleUser API is faster than SimpleRecord queries in terms of accessing user information.

Properties

s_user.accessToken

---

warning

Starting from the Platform version 1.29.0, a user's token is stored in a cookie with the HttpOnly and Secure parameters. This property is deprecated and always returns undefined.

A deprecated property. It was used to get the access token of the current user.

Return:

Type	Description
String	Returns undefined.

s_user.firstName

---

Use this property to get the first name of the current user.

Return:

Type	Description
String	Returns the first name of the current user.

Example:

s_user.firstName

console.log(s_user.firstName);
//John

s_user.lastName

---

Use this property to get the last name of the current user.

Return:

Type	Description
String	Returns the last name of the current user.

Example:

s_user.lastName

console.log(s_user.lastName);
//Doe

s_user.userID

---

Use this property to get the ID of the current user.

Return:

Type	Description
String	Returns the ID value for the current user.

Example:

s_user.userID

const currentCaller = new SimpleRecord(s_user.user.essence);
currentCaller.get(s_user.userID, ()=> {
  s_form.setValue('email', currentCaller.email);
});

s_user.user

---

Use this property to store an object with the user data of the current user, such as first name, last name, ID value, and other.

Return:

Type	Description
Object	Returns an object that contains user information.

Example:

s_user.user

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_access": null
}"*/

s_user.userName

---

Use this property to get the login (username) of the current user (for example, helpdesk.agent).

Return:

Type	Description
String	Returns the username of the current user.

Example:

s_user.userName

console.log(s_user.userName);
//"admin"

Methods

s_user.getFullName()

---

Use this method to get the full name of the current user (the values of the First name and Last name fields).

Return:

Type	Description
String	This method returns the first and the last name of the current user.

s_user.getPreference(name)

---

Use this method to get the specified preference values for the current user.

caution

Note that this method is asynchronous; for better performance, use the await keyword, as in the code example below.

Parameter(s):

Name	Type	Mandatory	Default value
name	Array of Strings	Y	N

Return:

Type	Description
Object	This method returns a Promise object that contains specific data.

note

It is possible to pass a single preference name as a string. To pass more than one preference name, use the Array type, as shown in the code example below.

Example:

getPreference (String type)

const getMyPreference = async () => {
    const response = await s_user.getPreference('preference_name');
};

getPreference (Array type)

const getMyPreference = async () => {
    const response = await s_user.getPreference(['preference_name', 'preference2_name']);
};

s_user.setPreference(name, value)

---

Use this method to define a value to the specified preference for the current user. To get a value of a previously set preference, use the s_user.getPreference(name) method.

caution

Note that this method is asynchronous; for better performance, use the await keyword, as shown in the code example below.

Parameter(s):

Name	Type	Mandatory	Default value
name	String	Y	N
value	String	Y	N

Return:

Type	Description
Object	This method returns a Promise object that contains specific data.

Example:

setPreference()

const setMyPreference = async () => {
    const response = await s_user.setPreference('menu.tab', 1);
};