This class provides methods to configure lists. Use these methods to manipulate them, for example, in thescripts of the UI actions.

Global variable usage

Within any list, you can use the predefined global variable.

Example:

window.currentUiAction

s_list.addErrorMessage(message)

This method displays an error toast message in the bottom right corner.

Parameter(s):

Return:

Example:

s_list.addErrorMessage('Please enter a valid email address using the following format: joe@example.com');

s_list.addInfoMessage(message, durationMilliseconds)

This method displays info messages when working with lists. They appear in the bottom right corner. The message disappears after a certain period of time. Specify this period in milliseconds in the second parameter.

Parameters:

Return:

Example:

s_list.addInfoMessage('Link copied to clipboard', 2000);

s_list.addSuccessMessage(message, durationMilliseconds)

This method displays success messages when working with lists. They appear in the bottom right corner. The message disappears after a certain period of time. Specify this period in milliseconds in the second parameter.

Parameters:

Return:

Example:

s_list.addSuccessMessage('Record was successfully updated!', 3000);

s_list.addWarningMessage(message, durationMilliseconds)

This method displays warning messages when working with lists. They appear in the bottom right corner. The messages disappear after a certain period of time. Specify this period in milliseconds in the second parameter.

Parameter(s):

Return:

Example:

s_list.addWarningMessage('This record has been modified by another user', 3000);

deleteRows(tableName, sysIds)

Use this method to delete one or more selected records, their IDs are passed in the second parameter.

Parameters:

Return:

Example:

s_i18n.getMessage("Delete the selected record(s)?", async (translationResponse) => {
  if (confirm(translationResponse)) {
    s_list.deleteRows(table, selectedRows)
      .then(() => {
        __resolveServerResponse();
        s_list.refresh(table);
      })
  } else {
    __resolveServerResponse();
  }
});

getCheckedRow(tableName)

Use this method to get information about the strings that are checked on the list.

Parameter:

Return:

Example:

const table = s_list.getTablesName()[0];
const selectedRows = s_list.getCheckedRow(table);
if (!selectedRows.length) {
  s_i18n.getMessage("No selected rows.", (translationResponse) => {
    __resolveServerResponse();
    alert(translationResponse);
  });
}

getQuery()

This method returns the filter condition for the displayed records in the list.

Return:

Example:

; (() => {
  const url = new URL(`${API_BASE_URL}/list/${s_list.getTablesName()[0]}`);
  url.searchParams.set('condition', s_list.getQuery());
  window.open(url, '_blank');
})();

getTablesName()

This method returns an array with the names of the tables displayed in the window.

Return:

Example:

; (() => {
  const url = new URL(`${API_BASE_URL}/list/${s_list.getTablesName()[0]}`);
  url.searchParams.set('condition', s_list.getQuery());
  window.open(url, '_blank');
})();

refresh(tableName)

This method refreshes data on the list specified in the tableName parameter.

Parameter:

Return:

Example:

if (confirm(translationResponse)) {
  s_list.deleteRows(table, selectedRows)
    .then(() => {
      s_list.refresh(table);
    })
}