Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Данный класс позволяет возвращать переведенные сообщения. У него нет конструктора, доступ к методам осуществляется через s_i18n глобальный объект.
getMessage(msgKey, config, callback)
Этот метод возвращает перевод заданной строки в форме строки, содержащей сообщение на языке пользователя. Если строка не существует или не имеет перевода на текущий язык, метод возвращает значение msgKey.
Параметр msgKey отправляет строку на перевод, а параметр callback является функцией, которая выполняется после ответа сервера.
Параметры:
Название | Тип | Обязательное | Дефолтное значение |
---|---|---|---|
msgKey | СтрокаString | Д | Н |
config | ОбъектObject | Н | '' |
callback | ФункцияFunction | Н | Н |
Параметр config применяется в качестве объекта, содержащего три параметра:
Название | Тип | Обязательное | Дефолтное значение |
---|---|---|---|
language | СтрокаString | Н | '' |
category | СтрокаString | Н | 'app' |
params | ОбъектString | Н | '' |
Параметр language может принимать принимает значения, указанные в словаре Languages (sys_language). Если он не указан, метод будет вызывать использовать текущий язык пользователя.
Параметр category может принимать принимает значения, указанные в записи таблицы Source Message (source_message) в поле Category.
Параметр params позволяет объекту получать значения параметров language и category для того, чтобы сохранить и сохранять значение плэйсхолдера из параметра msgKey.
Пример:
Note | |||||||||
---|---|---|---|---|---|---|---|---|---|
Как правило, параметр config не является обязательным, поэтому для получения перевода можно использовать функции обратного вызова:
|
Note |
---|
Данный метод является асинхронным. Для оптимальной работы используйте ключевое слово await как в примере ниже. |
ReturnВозврат:
Тип |
---|
Описание |
---|
String |
Данный метод возвращает сообщение, переведенное на указанный язык при соответствующей настройке. |
Пример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):
Этот метод возвращает массив строк, который содержит сообщения на языке пользователя. Если данные строки не локализованы для текущего языка или не существуют, метод возвращает значения строки msgKey.
Параметр msgKeys передает массив строк на перевод. Параметр callback является функцией, которая выполняется после ответа сервера.
Параметры:
Название | Тип | Обязательное | Дефолтное значение | 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:
Параметр config применяется в качестве объекта, содержащего три параметра:
Название | Тип | Обязательное | Дефолтное значение |
---|
language | String |
Н | '' |
category | String |
Н | 'app' |
params | Object |
Н | '' |
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).
Note |
---|
Note that this method is asynchronous; for better performance, use the await keyword as in the code example below. |
Return:
Параметр params позволяет объекту получать значения параметров language и category и сохранять значение плэйсхолдера из параметра msgKey.
Note |
---|
Данный метод является асинхронным. Для оптимальной работы используйте ключевое слово await как в примере ниже. |
Возврат:
Тип | Описание |
---|---|
Array of strings | Метод возвращает массив строк, которые могут быть переведены на заданный язык при соответствующей настройке. |
Пример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.При использовании одного и того же плэйсхолдера в разных сообщениях метод getMessages() возвращает одинаковые значения.
|
Table of Contents | ||||
---|---|---|---|---|
|