api.notification Отправка уведомления

  • api.notification.sendWebPush(message, recipient)

    Отправка упрощенного уведомления в веб-интерфейсе. Отправляет уведомление с текстом message получателю recipient.

    Параметры:

    • message — текст уведомления
    • recipient — получатель уведомления (uuid либо объект)

    Возвращает true — уведомление успешно отправлено, иначе false.

  • api.notification.sendMobilePush(message, recipient)

    Отправка упрощенного уведомления в мобильное приложение. Отправляет уведомление с текстом message получателю recipient.

    Параметры:

    • message — текст уведомления
    • recipient — получатель уведомления (uuid либо объект)

    Возвращает true — уведомление успешно отправлено, иначе false.

  • api.notification.createPushMessage(message)

    api.notification.createPushMessage(message).setLink(link).setUseHtml(false). ... .showBrowser()

    Создание уведомления с дополнительными параметрами.

    Для отправки созданного уведомления используются методы api.notification.sendWebPush и api.notification.sendMobilePush

    Параметр:

    • message — текст уведомления

    Пример. Каждый из методов set*()/show*() возвращает this, поэтому для формирования объекта уведомления можно использовать следующий синтаксис:

    def push=api.notification.createPushMessage(message).setLink(link).setUseHtml(false). ... .showBrowser()

  • api.notification.sendWebPush(push, utils.get('employee$2601'))

    Отправка уведомления в веб-интерфейс.

    Возвращает true — уведомление успешно отправлено, иначе false.

  • api.notification.sendMobilePush(push, 'employee$2601'):

    Отправка уведомления в мобильное приложение.

    Возвращает true — уведомление успешно отправлено, иначе false.

  • api.notification.markEventsAsRead(events)

    Маркировка уведомлений, как прочитанных:

    Параметр:

    • events — коллекция строк-идентификаторов уведомлений

  • Параметры для создания уведомления с дополнительными параметрами

    Параметры уведомления в веб-интерфейсе:

    • push.setLink(api.web.open('employee$2601')) — Ссылка, на которую будет осуществлен переход при нажатии на уведомление (браузерное)
    • push.setUseHtml(true) — Установка флажка "В формате HTML". По умолчанию true
    • push.useTemplate('templateCode', ['var' : 'value']) — Применение шаблона стилей с кодом templateCode и контекстными переменными (Map<String (код), Object (значение)>). Из шаблона/текста уведомления можно обращаться к значению через ${код}
    • push.useTemplate('templateCode') — Применение шаблона стилей с кодом templateCode, без контекстных переменных. По умолчанию ассоциативный массив будет содержать {'content' : текст уведомления}
    • push.showBrowser() — Установка типа отображения "Только браузерное уведомление"
    • push.showInterfaceAlways() — Установка типа отображения "В интерфейсе всегда. Дополнительно браузерное уведомление, если вкладка неактивна". Установлено по умолчанию
    • push.showInterfaceAndBrowser() — Установка типа отображения "В интерфейсе и браузерное уведомление"
    • push.showInterfaceOnly() — Установка типа отображения "Только в интерфейсе"
    • push.getText() — Текст уведомления

    Параметры уведомления в мобильном приложении:

    • push.setLink(api.web.open('employee$2601')) — Ссылка, на которую будет осуществлен переход при нажатии на уведомление
    • push.setSubject(message) — Тема уведомления в мобильном приложении
    • push.setUseHtml(true) — Установка флажка "В формате HTML"
    • push.useTemplate('templateCode', ['var' : 'value']) — Применение шаблона стилей с кодом templateCode и контекстными переменными (Map<String (код), Object (значение)>). Из шаблона/текста уведомления можно обращаться к значению через ${код}
    • push.useTemplate('templateCode') — Применение шаблона стилей с кодом templateCode, без контекстных переменных. По умолчанию ассоциативный массив будет содержать {'content' : текст уведомления}
    • push.showSubject() — Заголовок уведомления содержит только тему уведомления
    • push.showSystemName() — Заголовок уведомления содержит значение параметра "Название системы" (настройки мобильного приложения вкладка "Прочее" — блок "Прочие настройки"). Установлено по умолчанию
    • push.showSystemNameAndSubject() — Заголовок уведомления содержит значение параметра "Название системы" (настройки мобильного приложения вкладка "Прочее" — блок "Прочие настройки") и тему уведомления, разделенные пробелом
    • push.getText() — Текст уведомления