Клиентские действия плагина Pushwoosh для Outsystems

Плагин предоставляет набор клиентских действий для управления push-уведомлениями. Эти действия позволяют регистрировать и отменять регистрацию устройств, устанавливать и получать теги, управлять сообщениями Inbox и многое другое.

Клиентские действия плагина Pushwoosh

CheckPushwooshPlugin

Проверяет, доступен ли в данный момент плагин Pushwoosh.

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

IsAvailable	Возвращает true, если плагин доступен для использования, в противном случае — false
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.

Пример использования

RegisterDevice

Регистрирует устройство для получения push-уведомлений и получает Push Token.

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

ApplicationCode	Text, код приложения Pushwoosh, полученный из настроек вашего аккаунта.

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

RegisterToken	Токен, полученный от Google или Apple для устройства
Success	Возвращает true, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.

UnregisterDevice

Отменяет регистрацию устройства для получения push-уведомлений.

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

Success	Возвращает true, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.

GetDeviceID

Получает ID устройства, который должен быть уникальным идентификатором.

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

DeviceHwid	Уникальный идентификатор устройства.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если произошла ошибка.

GetDeviceType

Получает тип устройства (Android, iOS или Windows).

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

DeviceTypeId	Идентификатор этого типа устройства.

GetTags

Получает данные тегов из Pushwoosh.

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

Success	Возвращает true, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.
Tags	Возвращает список записей (Key, Value), содержащий все теги, назначенные этому устройству.

Пример использования

1. Вызовите действие GetTags, чтобы получить данные тегов из Pushwoosh.
2. Возвращенные теги доступны через список GetTags.Tags.

3. Используйте действие LogMessage, чтобы записать в лог ключ и значение каждого тега.

PostEvent

Отправляет сообщение в Pushwoosh, когда в вашем приложении происходит определенное событие.

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

EventName	Text, название события
EventAttributes	Список записей (Key, Value), используемый для отправки дополнительных данных о событии в Pushwoosh (например, для действия “UserLogin” вы можете отправить данные для входа, такие как {"username":"John"})

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

Success	Возвращает true, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.

Пример использования

1. Assign

Настройте пары ключ-значение для определения данных события. Например, KeyValue1.AttributeName как “test1” и KeyValue1.Value как “test1value”. Аналогично определите KeyValue2 с соответствующим именем и значением атрибута.

2. Создайте списки атрибутов, которые будут связаны с событием.

3. Наконец, настройте действие PostEvent.

SetBadgeNumber

Устанавливает число на значке приложения (badge).

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

BadgeNumber	Integer, число на значке приложения.

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

Success	Возвращает true, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.

SetLanguage

Устанавливает пользовательский язык приложения вместо системного языка по умолчанию.

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

Language	Text, пользовательский язык приложения в 2-буквенном формате ISO (например, “en”, “es”, “fr”)

SetTags

Отправляет теги и их значения в Pushwoosh.

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

Tags	Список записей (TagName, TagValue), содержащий все теги, которые вы хотите отправить. Тип TagName всегда должен быть Text, в то время как TagValue может быть Text, Integer, Boolean, Date и т. д.

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

Success	Возвращает true, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.

Пример использования

1. Присвойте значения тегам. В примере ниже есть два тега:

• Tag1 с именем testTag и значением, установленным на текущую дату.
• Tag2 с именем testTag2 и значением, установленным на True.

2. Затем добавьте теги в список. В этом примере:

• ListAppend3 добавляет Tag1 в список LocalTag.
• ListAppend4 добавляет Tag2 в список LocalTag.

3. После заполнения списка необходимыми тегами используйте клиентское действие SetTags, чтобы отправить этот список в Pushwoosh.

SetUserId

Присваивает этому устройству пользовательский User ID.

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

UserID	Text, пользовательский User ID.

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

Success	Возвращает true, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.

SetApiToken

Устанавливает Device API token Pushwoosh, используемый SDK. Вызовите его перед RegisterDevice. Токен также можно установить во время сборки с помощью параметра PW_API_TOKEN — см. руководство по интеграции.

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

Token	Text, Device API token из Pushwoosh Control Panel (раздел API Access).

EnableHuaweiPushNotifications

Переключает транспорт для push-уведомлений на Huawei Push Kit (HMS). Вызовите его перед RegisterDevice на устройствах Huawei. Требуется конфигурация Huawei — см. Huawei для Outsystems.

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

SetMultiNotificationMode

Доступно с версии компонента Pushwoosh Plugin 4.7.0. Только для Android — делает так, чтобы каждое push-уведомление появлялось как отдельное уведомление, а не заменяло предыдущее. Вызовите его один раз после инициализации — например, в обработчике события OnInitializeOver, после RegisterDevice. Настройка сохраняется SDK и остается после перезапуска приложения. Android группирует уведомления в один расширяемый стек — это стандартное поведение системы. Реализации для iOS нет (iOS никогда не заменяет уведомления) — защитите вызов с помощью GetDeviceType, а не помещайте его в поток, который также выполняется на iOS.

GetDiagnostics

Доступно с версии компонента Pushwoosh Plugin 4.7.0. Возвращает состояние интеграции в виде JSON-строки: действующий и встроенный код приложения и его источник, наличие API-токена, HWID, push-токен, состояние разрешения на уведомления, а также версии плагина и нативного SDK. На Android дополнительно включает User ID и список сервисов, зарегистрированных для событий обмена сообщениями FCM/HMS (эти два поля отсутствуют на iOS). Прикрепляйте его вывод к тикетам в службу поддержки вместо сбора логов устройства.

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

DiagnosticsJSON	Text, состояние интеграции в виде JSON-строки.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке.

Пример вывода (Android):

{
  "platform": "android",
  "packageName": "com.example.app",
  "appIdEffective": "XXXXX-XXXXX",
  "appIdManifest": "XXXXX-XXXXX",
  "appIdSource": "manifest",
  "apiTokenInManifest": false,
  "hwid": "d3ba13b6-…",
  "pushToken": "eAvqvOE0…",
  "userId": "d3ba13b6-…",
  "notificationsEnabled": true,
  "messagingServices": [
    { "action": "com.google.firebase.MESSAGING_EVENT", "class": "com.pushwoosh.firebase.PushFcmIntentService", "priority": 0 }
  ],
  "pluginVersion": "8.3.72-OS.1",
  "nativeSdkVersion": "6.11.1"
}

Клиентские действия Pushwoosh Inbox

Процесс работы с Inbox следующий:

1. Загрузите список объектов InboxMessage.
2. Используйте эти объекты для отображения представления входящих сообщений.
3. Выполните действия, перечисленные ниже, или удалите эти объекты с помощью описанных ниже действий.

code	Text	Уникальный ID уведомления в Inbox.
title	Text	Заголовок уведомления.
message	Text	Текст уведомления.
imageUrl	Text	URL пользовательского изображения, прикрепленного к уведомлению.
sendDate	Date Time	Представляет время отправки уведомления.
type	Integer	Тип уведомления. Возможные значения: 0 - обычное уведомление 1 - rich media уведомление 2 - URL-уведомление 3 - deep link уведомление
bannerUrl	Text	Содержит URL баннера для Android.
customData	Key, Value Record List	Содержит список параметров, переданных как custom data.
isRead	Boolean	True, если уведомление в Inbox прочитано.
isActionPerformed	Boolean	True, если действие с уведомлением выполнено. Для обычных уведомлений — true, если уведомление прочитано. Для Rich Media — true, если rich media было показано. Для URL и deep link — true, если URL/deep link был открыт.

LoadMessages

Получает уведомления Inbox из Pushwoosh.

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

InboxMessages	Список InboxMessage, список всех сообщений в Inbox.
Success	Возвращает true, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.

ReadMessage

Помечает сообщение в Inbox как прочитанное.

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

MessageCode	Text, код InboxMessage (полученный как параметр InboxMessage в LoadMessages)

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

Success	True, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.

PerformAction

Выполняет действие для указанных сообщений в Inbox (например, открывает URL в браузере).

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

MessageCode	Text, код InboxMessage (полученный как параметр InboxMessage в LoadMessages)

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

Success	Возвращает true, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.

DeleteMessage

Удаляет сообщение из Inbox.

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

MessageCode	Text, код InboxMessage (полученный как параметр InboxMessage в LoadMessages)

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

Success	Возвращает true, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.

TotalMessagesCount

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

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

MessagesCount	Integer, общее количество сообщений в Inbox.
Success	Возвращает true, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.

UnreadMessagesCount

Возвращает количество непрочитанных сообщений в Inbox.

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

UnreadMessagesCount	Integer, количество непрочитанных сообщений в Inbox.
Success	Возвращает true, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.

MessagesWithNoActionPerformedCount

Возвращает количество сообщений в Inbox, с которыми не было выполнено никаких действий.

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

MessagesWithNoActionPerformedCount	Integer, количество сообщений в Inbox, с которыми не было выполнено никаких действий.
Success	Возвращает true, если все прошло успешно, и false, если произошла ошибка.
Error	Ошибка, содержащая код и сообщение с подробной информацией о возможной ошибке. Устанавливается только в том случае, если выходной параметр Success имеет значение false.