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

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

Клиентские действия плагина 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

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

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

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

GetDeviceType

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

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

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

GetTags

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

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

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

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

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

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

PostEvent

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

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

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

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

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

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

1. Назначение (Assign)

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

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

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

SetBadgeNumber

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

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

BadgeNumber	Integer, число для иконки приложения (badge).

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

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

SetLanguage

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

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

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

SetTags

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

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

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

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

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

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

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

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.

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

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

Загрузите список объектов InboxMessage.
Используйте эти объекты для отображения представления Inbox.
Выполните действия, перечисленные ниже, или удалите эти объекты, используя описанные ниже действия.

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.