Skip to content
Руководство пользователя Wavesend.ru
Войти

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

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

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

Section titled “Клиентские действия плагина Wavesend”

CheckPushwooshPlugin

Section titled “CheckPushwooshPlugin”

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

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

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

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

Section titled “Пример использования”
CheckPushwooshPlugin action

RegisterDevice

Section titled “RegisterDevice”

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

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

Section titled “Входные параметры”
ApplicationCodeText, Application code для Wavesend, полученный из настроек вашей учетной записи.

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

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

UnregisterDevice

Section titled “UnregisterDevice”

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

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

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

GetDeviceID

Section titled “GetDeviceID”

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

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

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

GetDeviceType

Section titled “GetDeviceType”

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

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

Section titled “Выходные параметры”
DeviceTypeIdИдентификатор этого типа устройства.

GetTags

Section titled “GetTags”

Получает данные tags из Wavesend.

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

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

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

Section titled “Пример использования”
  1. Вызовите действие GetTags, чтобы получить данные tags из Wavesend.
  2. Возвращенные tags доступны через список GetTags.Tags.
  1. Используйте действие LogMessage, чтобы записать в лог ключ и значение каждого tag.

PostEvent

Section titled “PostEvent”

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

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

Section titled “Входные параметры”
EventNameText, название Event
EventAttributesСписок записей (Key, Value Record List), используемый для отправки дополнительных данных Event в Wavesend (например, для действия “UserLogin” вы можете отправить данные для входа, такие как - {“username”:“John”})

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

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

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

Section titled “Пример использования”

1. Assign

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

  1. Создайте списки атрибутов для связи с Event.
  1. Наконец, настройте действие PostEvent.

SetBadgeNumber

Section titled “SetBadgeNumber”

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

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

Section titled “Входные параметры”
BadgeNumberInteger, число на значке приложения.

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

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

SetLanguage

Section titled “SetLanguage”

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

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

Section titled “Входные параметры”
LanguageText, пользовательский язык приложения в двухбуквенном формате ISO (например, “en”, “es”, “fr”)

SetTags

Section titled “SetTags”

Отправляет tags и их значения в Wavesend.

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

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

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

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

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

Section titled “Пример использования”
  1. Присвойте значения tag. В примере ниже есть два tags:
  • Tag1 с именем testTag и значением, установленным на текущую дату.
  • Tag2 с именем testTag2 и значением, установленным на True.
  1. Затем добавьте tags в список. В этом примере:
  • ListAppend3 добавляет Tag1 в список LocalTag.
  • ListAppend4 добавляет Tag2 в список LocalTag.
  1. После заполнения списка необходимыми tags, используйте клиентское действие SetTags, чтобы отправить этот список в Wavesend.

SetUserId

Section titled “SetUserId”

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

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

Section titled “Входные параметры”
UserIDText, пользовательский User ID.

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

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

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

Section titled “Клиентские действия Wavesend Inbox”

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

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

Date

Time

Представляет время отправки уведомления.
typeInteger

Тип уведомления.

Возможные значения:

  • 0 - обычное уведомление
  • 1 - уведомление с rich media
  • 2 - URL-уведомление
  • 3 - уведомление с Deep Link
bannerUrlTextСодержит URL-адрес баннера для Android.
customDataСписок записей (Key, Value Record List)Содержит список параметров, переданных как custom data.
isReadBooleanTrue, если уведомление в Inbox прочитано.
isActionPerformedBoolean
  • True, если действие с уведомлением выполнено.
  • Для обычных уведомлений — true, если уведомление прочитано.
  • Для Rich Media — true, если rich media было показано.
  • Для URL и Deep Link — true, если URL/Deep Link был открыт.

LoadMessages

Section titled “LoadMessages”

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

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

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

ReadMessage

Section titled “ReadMessage”

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

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

Section titled “Входные параметры”
MessageCodeText, код InboxMessage (полученный как параметр InboxMessage в LoadMessages)

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

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

PerformAction

Section titled “PerformAction”

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

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

Section titled “Входные параметры”
MessageCodeText, код InboxMessage (полученный как параметр InboxMessage в LoadMessages)

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

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

DeleteMessage

Section titled “DeleteMessage”

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

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

Section titled “Входные параметры”
MessageCodeText, код InboxMessage (полученный как параметр InboxMessage в LoadMessages)

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

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

TotalMessagesCount

Section titled “TotalMessagesCount”

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

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

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

UnreadMessagesCount

Section titled “UnreadMessagesCount”

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

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

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

MessagesWithNoActionPerformedCount

Section titled “MessagesWithNoActionPerformedCount”

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

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

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