Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Данный класс позволяет возвращать переведенные сообщения. У него нет конструктора, доступ к методам осуществляется через s_i18n глобальный объект.
getMessage(msgKey, config, callback)
Этот метод возвращает перевод заданной строки в форме строки, содержащей сообщение на языке пользователя. Если строка не существует или не имеет перевода на текущий язык, данный метод возвращает значение msgKey.
The msgKey parameter should pass the string for translation, and the callback parameter is the function that is executed after the server response.
Parameter(s):
Параметр msgKey отправляет строку на перевод, а параметр callback является функцией, которая выполняется после ответа сервера.
Параметры:
Название | Тип | Обязательное | Дефолтное значение |
---|---|---|---|
msgKey | Строка | Д | Н |
config | Объект | Н |
'' | |
callback |
Функция |
Н |
Н |
The config parameter is implemented as an object containing three other parameters:
Параметр config применяется в качестве объекта, содержащего три параметра:
Название | Тип | Обязательное | Дефолтное значение |
---|---|---|---|
language | Строка | Н | |
Name | Type | Mandatory | Default Value |
language | String | N | '' |
category | StringСтрока | NН | 'app' |
params | ObjectОбъект | NН | '' |
The language parameter can take on the values specified in the Параметр language может принимать значения, указанные в словаре Languages (sys_language) dictionary. If it is not specified, the current user's language is used when the method is called.. Если он не указан, метод будет вызывать текущий язык пользователя.
Параметр category может принимать значения, указанные в записи таблицы The category parameter can take on the values specified in the Category field of the Source Message (source_message) table recordв поле Category .The params parameter provides an object service to aggregate the language and category parameter values and to keep the placeholder values from the msgKey parameter (see the code example below).
Параметр params позволяет объекту получать значения параметров language и category для того, чтобы сохранить значение плэйсхолдера из параметра msgKey.
Пример:
Note | |||||||||
---|---|---|---|---|---|---|---|---|---|
Generally, the config parameter is non-mandatory, so you can use callback functions to get translations:
|
Note |
---|
Note that this method is asynchronous; for better performance, use the await keyword as in the code example below. |
Return:
Type | Description |
---|---|
String | This method returns a message, optionally translated in the language specified. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (!s_form.getValue('condition')) { await s_i18n.getMessage('Specify conditions in "Condition" [condition] field.', (response) => { s_form.addErrorMessage(response); }); return false; } |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const serviceNameValue = 'Email'; s_i18n.getMessage('Sorry, {serviceName} Service Is Temporarily Unavailable', {params: {"serviceName": serviceNameValue}, language: "en", category: "app"}, (response) => console.log(response)); // Sorry, Email Service Is Temporarily Unavailable |
getMessages(msgKeys, config, callback)
This method returns an array of strings that contains messages in a user language. If these strings do not have localization for the current language, or they do not exist at all, the method returns msgKey string values.
The msgKeys parameter should pass the array of strings for translation, and the callback parameter is the function that is executed after the server response.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
msgKey | String | Y | N |
config | Object | N | '' |
callback | Function | N | N |
The config parameter is implemented as an object containing three other parameters:
Name | Type | Mandatory | Default Value |
---|---|---|---|
language | String | N | '' |
category | String | N | 'app' |
params | Object | N | '' |
The language parameter can take on the values specified in the Languages (sys_language) dictionary. If it is not specified, the current user's language is used when the method is called.
The category parameter can take on the values specified in the Category field of the Source Message (source_message) table record.
The params parameter provides an object service to aggregate the language and category parameter values and to keep the placeholder values from the msgKey parameter (see the code example below).
Note |
---|
Note that this method is asynchronous; for better performance, use the await keyword as in the code example below. |
Return:
Type | Description |
---|---|
Array of strings | This method returns an array of messages, optionally translated into the language specified. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const data = {}; const btnTitles = ['Accept', 'Cancel']; await s_i18n.getMessages(btnTitles, (response) => { [data.acceptBtnTitle, data.cancelBtnTitle] = response; }); console.log(JSON.stringify(data)); // {"acceptBtnTitle":"Accept","cancelBtnTitle":"Cancel"} |
Note | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Note that if you use the same placeholders for different messages, the getMessages() method output contains the same values on their place.
|
Table of Contents | ||||
---|---|---|---|---|
|