Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Функции

AddMessage

void AddMessage(int4 importance, string text)

Добавляет в журнал сообщение с заданной важностью. Если в свойстве AdditionalColumns указаны дополнительные столбцы, используйте функцию Add().

Входные параметры:

  • важность;
  • текст сообщения.

Важность обозначается цифрой:

  • 0 – отладочное информационное сообщение, цвет фона – белый;
  • 1 – информационное сообщение, цвет фона – зеленый;
  • 2 – важное сообщение, цвет фона – желтый;
  • 3 – сообщение об ошибке, цвет фона – красный.
LogView.AddMessage(3, "Прервано соединение с сервером 127.0.0.1")

Add

void Add(int4 importance, string text, string additional)

Добавляет в журнал сообщение с заданной важностью и дополнительными данными. Эта функция используется, если в свойстве AdditionalColumns указаны дополнительные столбцы.

Входные параметры:

  • важность;
  • текст сообщения;
  • дополнительные данные в виде json-строки:
    { "id1":value1, "id2":value2, ... },
    помещаемые в дополнительные столбцы таблицы сообщений.

При вызове функции в JavaScript понадобится метод JSON.stringify() для преобразования данных в json-строку:

Log.Add(3, "Прервано соединение с сервером 127.0.0.1", JSON.stringify({"address":"127.0.0.1", "port":4388}))

При вызове функции в Alpha.Om представьте данные в виде строки, заключив их в кавычки, а кавычки внутри строки экранируйте обратным слешем:

Log.Add(3, "Прервано соединение с сервером 127.0.0.1", "{ \"address\":\"127.0.0.1\", \"port\":4388 }")

Clear

void Clear()

Очищает журнал сообщений.

GetViewSettings

string GetViewSettings()

Возвращает настройки отображения журнала в виде json-строки.

Настройки отображения содержат информацию о ширине столбцов, порядке сортировки, включенных кнопках фильтрации, текст поиска, режим слежения за последним сообщением, путь к папке для экспорта, расширение экспортируемых файлов. Эти настройки могут использоваться для восстановления отображения журнала с помощью функции UpdateView() при перезапуске проекта.

Пример возвращаемого значения:

{
"Columns": {
"importance": {
"Index": 0,
"Width": 20,
"Hidden": true
},
"time": {
"Index": 1,
"Width": 150,
"Hidden": false
},
"text": {
"Index": 2,
"Width": 424,
"Hidden": false
}
},
"Filter": 
{
"Errors": true,
"Warnings": true,
"Informations": true,
"Text": ""
},
"FollowLatest": false,
"ExportToFile":
{
"Folder":"",
"FileType":0
}
}

UpdateView

void UpdateView(string settings)

Настраивает отображение журнала в соответствии с настройками, которые могут быть получены в результате вызова функции GetViewSettings().

Входной параметр – настройки отображения журнала в виде json-строки.