Компонент Уведомление

Содержание

Описание
Свойства
См. также

Описание

Отправляет сообщение указанному адресату. В том числе может размещать сообщение в лог-файле обработчика сценариев.

Для пользователя системы уведомление – это websocket-сообщение от сервера по существующему websocket-подключению. В частности, веб-приложение "Редактор сценариев" отображает уведомления в виде всплывающих сообщений, чем удобно пользоваться в режиме отладки сценария при написании. В качестве адресатов может быть указан через запятую список из пользователей: их логинов, идентификаторов, логинов связанных с ними учетных записей SIP-пользователей или их номеров.

Уведомление может отправлять SIP-запросы NOTIFY на устройства SIP-пользователей с размещением сообщения в теле запроса согласно протоколу SIP.

Table 1. Системные характеристики

Индекс	`111`
Краткое название	`notify`
Типы сценариев	`Все`
Стартовый модуль	`r_script_component_notify`
Режим	Асинхронный
Иконка
Характер разветвления	Разветвляющий, замыкающий

Свойства

Table 2. Свойства
Спецификация	Описание
Название: `Режим` Код: `mode` Усл. видимости: `нет` По умолчанию: `Лог журнал`	Возможные варианты: `Уведомление API` (`scriptnotify`, `0`) – Отправляет сообщение типа `script_notify` в websocket-подключение указанного пользователя. Для успешного прохождения события в подключении должна быть подключена capability `scriptnotify`. Веб-приложение "Редактор сценариев" обрабатывает такие сообщения. В любом другом приложение также может быть реализована подписка и обработка уведомлений из сценариев. `Лог журнал` (`log`, `1`) – Сообщение заносится в лог журнал сценарной машины с привязкой к текущему сценарию и обработчику. `Сообщение sip` (`sip`, `2`) – Сообщение отправляется на SIP-устройство пользователя в виде SIP-запроса.
Название: `Текст` Код: `text` Усл. видимости: `да` По умолчанию: —	Текст сообщения для режимов `Уведомление API` и `Лог-журнал`.
Название: `Пользователь` Код: `user` Усл. видимости: `да` По умолчанию: —	Аргумент, определяющий пользователя или список пользователей, перечисленных через запятую. Логин, идентификатор, логин или номер привязанной учетной записи SIP. Для режима `Уведомление API`.
Название: `Тип отображения` Код: `type` Усл. видимости: `да` По умолчанию: `Авто`	Способ отображения в пользовательском интерфейсе. Формирует дополнительную опцию в websocket-сообщении. Возможные варианты: `Авто` (`auto`, `0`) – Способ уведомления на усмотрение приложения. `WebKit` (`webkit`, `1`) – Уведомление с помощью WebKit. `HTML` (`html`, `3`) – Уведомление с помощью средств HTML. Для режима `Уведомление API`.
Название: `Тип уведомления` Код: `notifyType` Усл. видимости: `да` По умолчанию: `Инфо`	Форматирование уведомления. Возможные варианты: `Инфо` (`info`, `0`) – Способ уведомления на усмотрение приложения. `Успех` (`success`, `1`) – Уведомление с помощью WebKit. `Предупреждение` (`warning`, `2`) – Уведомление с помощью средств HTML. `Ошибка` (`error`, `3`) – Уведомление с помощью средств HTML. Для режима `Уведомление API`
Название: `Цвет фона` Код: `color` Усл. видимости: `да` По умолчанию: —	Пользовательский цвет фона в виде числа, соответствующего представлению RGB 24bit. Для режима `Уведомление API`.
Название: `Цвет текста` Код: `textColor` Усл. видимости: `да` По умолчанию: —	Пользовательский цвет текста в виде числа, соответствующего представлению RGB 24bit. Для режима `Уведомление API`.
Название: `Группа` Код: `group` Усл. видимости: `да` По умолчанию: —	Код группы сообщений для автоматического скрывания при дублировании. Приложение, отображающее уведомление, должно автоматически скрывать находящееся на экране сообщение при поступлении нового сообщения с тем же кодом группы. Для режима `Уведомление API`.
Название: `Автоскрытие, с` Код: `autoHide` Усл. видимости: `да` По умолчанию: —	Интервал, по истечению которого уведомление должно исчезнуть с экрана, если пользователь не произвел с ним никаких действий. Для режима `Уведомление API`.
Название: `Дублировать в лог` Код: `writeLog` Усл. видимости: `да` По умолчанию: `Нет`	Выключатель дополнительного логирования сообщения в лог обработчика сценариев. Для режима `Уведомление API`.
Название: `Сообщение` Код: `sipMsg` Усл. видимости: `да` По умолчанию: `NOTIFY`	Метод отправляемого SIP-запроса. Возможные варианты: `NOTIFY` (`notify`, `0`) `INFO` (`info`, `1`) `MESSAGE` (`message`, `2`) Для режима `Уведомление API`.
Название: `Пользователь` Код: `sipUser` Усл. видимости: `да` По умолчанию: —	Адресат в формате `tel:username` или `username`, где в качестве `username` могут подставляться логин и номер учетной записи SIP-пользователя. Для режима `Сообщение SIP`.
Название: `Дополнительные заголовки` Код: `sipHeaders` Усл. видимости: `да` По умолчанию: ``	Подставляемые в SIP-запрос дополнительные заголовки. Аргумент содержит мультистрочное значение, формат каждой из строк: `HeaderName: HeaderValue`. Для режима `Сообщение SIP`.
Название: `From` Код: `sipFrom` Усл. видимости: `да` По умолчанию: —	Подставляемое в отправляемый SIP-запрос значение для заголовка From. Для режима `Сообщение SIP`.
Название: `Event` Код: `sipEvent` Усл. видимости: `да` По умолчанию: —	Подставляемое в отправляемый SIP-запрос NOTIFY значение для заголовка Event. Для режима `Сообщение SIP`.
Название: `Content-Type` Код: `sipContentType` Усл. видимости: `да` По умолчанию: —	Подставляемое в отправляемый SIP-запрос значение для заголовка Content-Type. Для режима `Сообщение SIP`.
Название: `Content` Код: `sipContent` Усл. видимости: `да` По умолчанию: —	Текст сообщения, подставляемый в тело отправляемого SIP-запроса. Для режима `Сообщение SIP`.
Название: `Ожидать подтверждения` Код: `sipReport` Усл. видимости: `да` По умолчанию: `Нет`	Выключатель режима ожидания SIP-ответа на отправленный SIP-запрос. Для режима `Сообщение SIP`.
Название: `Отчет в переменную` Код: `sipReportMsg` Усл. видимости: `да` По умолчанию: —	Переменная для сохранения тела SIP-ответа на отправленный SIP-запрос. Для режима `Сообщение SIP`.
Название: `Время, с` Код: `sipTimeoutSec` Усл. видимости: `да` По умолчанию: `37`	Таймаут ожидания ответа на отправленный SIP-запрос, в секундах. Для режима `Сообщение SIP`.
Название: `Переход, время` Код: `transferTimeout` Усл. видимости: `да` По умолчанию: —	Компонент, которому передается управление в случае, если в режиме ожидания в установленное время не получен ответ на отправленный SIP-запрос. Для режима `Сообщение SIP`.
Название: `Причина ошибки в переменную` Код: `errMsg` Усл. видимости: `да` По умолчанию: —	Переменная для сохранения кода ошибки.
Название: `Переход` Код: `transfer` Усл. видимости: `нет` По умолчанию: —	Компонент, которому передается управление.
Название: `Переход, ошибка` Код: `transferError` Усл. видимости: `да` По умолчанию: —	Компонент, которому передается управление в случае возникновения ошибки.

См. также

Роль svc
Роль ws
Роль b2b