Действия модуля Pushwoosh для Mendix

Модуль Pushwoosh для Mendix предоставляет свою функциональность в двух местах: виджет Pushwoosh events, который запускает SDK и преобразует входящие уведомления в события нанопотоков, и действия JavaScript, которые вы вызываете из любого нанопотока в профиле навигации нативного мобильного приложения. На этой странице перечислены оба варианта.

Свойства виджета Pushwoosh events

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

Настройка (Setup)

Эти свойства запускают SDK и сообщают, когда он готов к работе.

Свойство	Что делает
Код приложения (Application Code)	Код приложения Pushwoosh для вашего приложения, например XXXXX-XXXXX. Обязательно.
Регистрировать при загрузке (Register on load)	Регистрирует устройство сразу после загрузки виджета. На iOS это вызывает системный запрос на разрешение, поэтому отключите эту опцию, если вы предпочитаете запрашивать разрешение позже с помощью действия RegisterForPushNotifications.
При инициализации (On initialized)	Нанопоток, который запускается один раз после запуска SDK.
При регистрации (On registered)	Нанопоток, который запускается, когда у устройства появляется push-токен.
Push-токен (Push token)	Строковый атрибут, в который записывается push-токен перед запуском On registered.

События push-уведомлений (Push events)

Эти свойства доставляют входящее уведомление в вашу модель и запускают нанопоток.

Свойство	Что делает
Полезная нагрузка (Payload)	Строковый атрибут, который получает полную полезную нагрузку уведомления в формате JSON.
Сообщение (Message)	Строковый атрибут, который получает текст уведомления.
При получении push-уведомления (On push received)	Нанопоток, который запускается, когда уведомление приходит, пока приложение находится на переднем плане.
При открытии push-уведомления (On push opened)	Нанопоток, который запускается, когда пользователь нажимает на уведомление.

Диплинки (Deep links)

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

Свойство	Что делает
Диплинк (Deep link)	Строковый атрибут, который получает URL диплинка из уведомления.
При переходе по диплинку (On deep link)	Нанопоток, который запускается, когда открытое уведомление содержит ссылку. Он запускается в дополнение к On push opened.

Атрибуты заполняются перед запуском нанопотока, поэтому нанопоток может сразу же их прочитать.

Действия по настройке

Используйте эти действия, когда вы запускаете SDK самостоятельно, а не через виджет.

Initialize

Инициализирует Pushwoosh SDK. Вызывайте его один раз перед любым другим действием Pushwoosh, обычно из нанопотока, выполняемого при загрузке главной страницы. Он не нужен, если на странице есть виджет Pushwoosh events, так как виджет сам инициализирует SDK.

На Android FCM Sender ID берется из файла google-services.json, который подхватывается при нативной сборке. Он не передается в это действие.

Параметр	Тип	Описание
applicationCode	String	Код приложения Pushwoosh, например XXXXX-XXXXX. Обязательно.
notificationHandling	String	Необязательно. default или manual. Оставьте пустым для стандартного поведения.

Возвращает логическое значение, которое равно true, если SDK был запущен.

Действия по регистрации

Эти действия управляют получением уведомлений этим устройством и предоставляют идентификаторы для его адресации.

RegisterForPushNotifications

Регистрирует устройство для получения push-уведомлений и возвращает push-токен. На iOS это вызывает системный запрос на разрешение, поэтому вызывайте это действие в тот момент, когда запрос будет понятен пользователю.

Возвращает строку с push-токеном.

UnregisterForPushNotifications

Отменяет регистрацию устройства. Оно перестает получать уведомления до тех пор, пока снова не будет вызвано действие RegisterForPushNotifications.

Возвращает строку с токеном, с которым устройство было отрегистрировано.

GetPushToken

Возвращает текущий push-токен или пустую строку, если устройство еще не зарегистрировано.

Возвращает строку.

GetHwid

Возвращает HWID устройства — идентификатор, по которому Pushwoosh его адресует. Используйте его для таргетинга на одно устройство из Панели управления Pushwoosh или через серверный API.

Возвращает строку.

Действия с идентификатором пользователя

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

SetUserId

Связывает устройство с пользователем. Вызывайте это действие после входа в систему.

Параметр	Тип	Описание
userId	String	Ваш собственный идентификатор пользователя. Обязательно.

Возвращает логическое значение.

GetUserId

Возвращает User ID, который в данный момент связан с устройством, или пустую строку, если он не установлен.

Возвращает строку.

SetEmails

Регистрирует адреса электронной почты пользователя в Pushwoosh, чтобы с ним можно было связаться как по email, так и через push-уведомления.

Параметр	Тип	Описание
emails	String	Один адрес или несколько, разделенных запятыми. Обязательно.

Возвращает логическое значение.

Действия с тегами

Теги (Tags) — это свойства устройства, на основе которых строятся сегменты в Панели управления Pushwoosh.

SetTags

Устанавливает теги на устройстве.

Параметр	Тип	Описание
tagsJson	String	Объект JSON, например {"Language":"en","Level":7,"Premium":true}. Обязательно.

Возвращает логическое значение.

Кавычки в выражениях Mendix

Строка в выражении Mendix заключается в одинарные кавычки, поэтому JSON внутри нее сохраняет свои двойные кавычки без экранирования: '{"Language":"en"}'. Использование "" или \" внутри выражения приведет к созданию строки, которую действие не сможет разобрать.

GetTags

Возвращает теги, установленные на устройстве в данный момент, в виде строки JSON.

Возвращает строку.

Действия с событиями

События (Events) — это то, что запускает триггерные кампании и in-app сообщения.

PostEvent

Отправляет событие в Pushwoosh.

Параметр	Тип	Описание
eventName	String	Имя события, как оно настроено в Панели управления. Обязательно.
attributesJson	String	Необязательно. Объект JSON с атрибутами события.

Возвращает логическое значение.

Базовый вызов SDK не сообщает об успехе или неудаче, поэтому действие возвращает true, как только вызов был передан в SDK.

Действия с локальными уведомлениями

Локальные уведомления создаются самим приложением и не требуют сети, что делает их подходящими для напоминаний.

ScheduleLocalNotification

Планирует локальное уведомление на устройстве.

Параметр	Тип	Описание
message	String	Текст уведомления. Обязательно.
afterSeconds	Integer/Long	Время ожидания перед показом в секундах. Обязательно, должно быть ноль или больше.
customDataJson	String	Необязательно. Объект JSON, который будет доставлен вместе с уведомлением.

Возвращает логическое значение, как только вызов был передан в SDK. SDK не сообщает, было ли уведомление действительно запланировано.

ClearLocalNotifications

Отменяет локальные уведомления, которые были запланированы, но еще не сработали.

Возвращает логическое значение, как только вызов был передан в SDK.

ClearNotificationCenter

Удаляет уже доставленные уведомления приложения из центра уведомлений.

Возвращает логическое значение, как только вызов был передан в SDK.

Действия, связанные с конфиденциальностью

Эти действия поддерживают переключатель согласия в вашем приложении и включают или выключают все сообщения Pushwoosh для устройства.

IsCommunicationEnabled

Сообщает, разрешено ли устройству в данный момент получать сообщения от Pushwoosh. Используйте это действие для отображения состояния переключателя конфиденциальности.

Возвращает логическое значение.

SetCommunicationEnabled

Включает или выключает связь с Pushwoosh для устройства. Отключение останавливает все сообщения, что делает это действие подходящим для привязки к переключателю “не связываться со мной”.

Параметр	Тип	Описание
enabled	Boolean	True, чтобы разрешить сообщения, false, чтобы остановить. Обязательно.

Возвращает логическое значение.

Действия с настройками

Эти действия изменяют поведение SDK для данного устройства.

SetLanguage

Переопределяет язык, который Pushwoosh использует для локализации сообщений для устройства. По умолчанию используется язык устройства.

Параметр	Тип	Описание
language	String	Двухбуквенный код, такой как en, de, nl. Обязательно.

Возвращает логическое значение, как только вызов был передан в SDK.

SetReverseProxy

Направляет весь трафик Pushwoosh через вашу собственную конечную точку. Вызывайте это действие перед Initialize, иначе ранние запросы все равно будут идти напрямую в Pushwoosh.

Параметр	Тип	Описание
url	String	Базовый URL прокси. Обязательно.
headersJson	String	Необязательно. Объект JSON с дополнительными HTTP-заголовками.

Возвращает логическое значение, как только вызов был передан в SDK.

SetShowForegroundAlert

Управляет тем, будет ли уведомление, пришедшее во время работы приложения, показано как системное оповещение. По умолчанию эта опция включена, поэтому отключите ее, чтобы самостоятельно обрабатывать уведомления на переднем плане через событие On push received виджета.

Параметр	Тип	Описание
showAlert	Boolean	True, чтобы показать системное оповещение. Обязательно.

Возвращает логическое значение, как только вызов был передан в SDK.

Только для iOS

Android SDK не предоставляет этот параметр, и вызов этого действия на Android приведет к ошибке. Вызывайте его только на iOS.

GetShowForegroundAlert

Сообщает, будет ли уведомление, пришедшее во время работы приложения, показано как системное оповещение. По умолчанию эта опция включена.

Возвращает логическое значение.

Только для iOS

Android SDK не предоставляет этот параметр, и вызов этого действия на Android приведет к ошибке. Вызывайте его только на iOS.

Действия для других каналов

Эти действия регистрируют пользователя для каналов обмена сообщениями, которые Pushwoosh поддерживает помимо push-уведомлений.

RegisterSmsNumber

Регистрирует номер телефона пользователя, чтобы Pushwoosh мог связаться с ним по SMS.

Параметр	Тип	Описание
phoneNumber	String	В международном формате, например +31201234567. Обязательно.

Возвращает логическое значение, как только вызов был передан в SDK.

RegisterWhatsappNumber

Регистрирует номер телефона пользователя, чтобы Pushwoosh мог связаться с ним через WhatsApp.

Параметр	Тип	Описание
phoneNumber	String	В международном формате, например +31201234567. Обязательно.

Возвращает логическое значение, как только вызов был передан в SDK.