Pushwoosh Outsystems 插件客户端操作

该插件提供了一组客户端操作，以方便推送通知管理。这些操作允许您注册和注销设备、设置和获取标签、管理收件箱消息等。

Pushwoosh 插件客户端操作

CheckPushwooshPlugin

验证 Pushwoosh 插件当前是否可用。

输出参数

IsAvailable	如果插件可用，则返回 true，否则返回 false
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。

使用示例

RegisterDevice

为推送通知注册设备并检索推送令牌。

输入参数

ApplicationCode	文本，从您的帐户设置中获取的 Pushwoosh 应用程序代码。

输出参数

RegisterToken	从 Google 或 Apple 收到的设备令牌
Success	如果一切正常，则返回 true，如果出现错误，则返回 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。

UnregisterDevice

注销设备以停止接收推送通知。

输出参数

Success	如果一切正常，则返回 true，如果出现错误，则返回 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。

GetDeviceID

检索设备 ID，该 ID 应为唯一标识符。

输出参数

DeviceHwid	设备的唯一标识符。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当出现错误时设置。

GetDeviceType

获取设备类型（Android、iOS 或 Windows）。

输出参数

DeviceTypeId	此设备类型的标识符。

GetTags

从 Pushwoosh 获取标签数据。

输出参数

Success	如果一切正常，则返回 true，如果出现错误，则返回 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。
Tags	返回包含分配给此设备的所有标签的键值记录列表。

使用示例

调用 GetTags 操作从 Pushwoosh 获取标签数据。
返回的标签可通过 GetTags.Tags 列表访问。

使用 LogMessage 操作记录每个标签的键和值。

PostEvent

当您的应用程序中发生特定事件时，向 Pushwoosh 发送消息。

输入参数

EventName	文本，事件的名称
EventAttributes	键值记录列表，用于向 Pushwoosh 发送额外的事件数据（例如，对于 “UserLogin” 操作，您可能希望发送登录数据，例如 - `{"username":"John"}`）

输出参数

Success	如果一切正常，则返回 true，如果出现错误，则返回 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。

使用示例

1. 分配

设置键值对以定义事件的数据。例如，将 KeyValue1.AttributeName 设置为 “test1”，将 KeyValue1.Value 设置为 “test1value”。同样，使用适当的属性名称和值定义 KeyValue2。

创建要与事件关联的属性列表。

最后，配置 PostEvent 操作。

SetBadgeNumber

设置应用程序图标的角标数字。

输入参数

BadgeNumber	整数，图标角标数字。

输出参数

Success	如果一切正常，则返回 true，如果出现错误，则返回 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。

SetLanguage

设置自定义应用程序语言，而不是默认的系统语言。

输入参数

Language	文本，双字母 ISO 格式的自定义应用程序语言（例如 “en”、“es”、“fr”）

SetTags

将标签及其值发送到 Pushwoosh。

输入参数

Tags	TagName、TagValue 记录列表，包含您要发送的所有标签。TagName 类型应始终为文本，而 TagValue 可以是文本、整数、布尔值、日期等。

输出参数

Success	如果一切正常，则返回 true，如果出现错误，则返回 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。

使用示例

分配标签值。在下面的示例中，有两个标签：

标签1，名称为 testTag，其值设置为当前日期。
标签2，名称为 testTag2，其值设置为 True。

然后，将标签附加到列表中。在此示例中：

ListAppend3 将标签1添加到 LocalTag 列表。
ListAppend4 将标签2添加到 LocalTag 列表。

使用必要的标签填充列表后，使用 SetTags 客户端操作将此列表发送到 Pushwoosh。

SetUserId

为此设备分配一个自定义 User ID。

输入参数

UserID	文本，自定义 User ID。

输出参数

Success	如果一切正常，则返回 true，如果出现错误，则返回 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。

SetApiToken

设置 SDK 使用的 Pushwoosh Device API 令牌。在 RegisterDevice 之前调用它。该令牌也可以在构建时使用 PW_API_TOKEN 首选项进行设置 — 请参阅集成指南。

输入参数

Token	文本，来自 Pushwoosh 控制面板（API 访问部分）的 Device API 令牌。

EnableHuaweiPushNotifications

将推送传输切换到华为推送服务 (HMS)。在华为设备上，在 RegisterDevice 之前调用它。需要华为配置 — 请参阅华为 Outsystems 集成。

该操作没有输出参数，也不报告成功或失败。要验证设备实际注册的传输方式，请使用 GetDiagnostics。

SetMultiNotificationMode

自 Pushwoosh 插件组件版本 4.7.0 起可用。 仅限 Android — 使每个推送都显示为单独的通知，而不是替换前一个。在初始化后调用一次 — 例如，在 OnInitializeOver 事件的处理程序中，在 RegisterDevice 之后。该设置由 SDK 存储，并在应用程序重新启动后仍然有效。Android 会将通知分组到一个可展开的堆栈中 — 这是标准的系统行为。没有 iOS 实现（iOS 从不替换通知）— 使用 GetDeviceType 来保护调用，而不是将其放入在 iOS 上也运行的流程中。

GetDiagnostics

自 Pushwoosh 插件组件版本 4.7.0 起可用。 以 JSON 字符串形式返回集成状态：有效的和内置的应用程序代码及其来源、API 令牌是否存在、HWID、推送令牌、通知权限状态以及插件和原生 SDK 版本。在 Android 上，它还包括 User ID 和为 FCM/HMS 消息事件注册的服务列表（这两个字段在 iOS 上不存在）。将其输出附加到支持工单，而不是收集设备日志。

输出参数

DiagnosticsJSON	文本，以 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 收件箱客户端操作

使用收件箱的流程如下：

加载 InboxMessage 对象列表。
使用这些对象渲染收件箱视图。
执行下面列出的操作，或使用下面描述的操作删除这些对象。

code	文本	收件箱通知的唯一 ID。
title	文本	通知标题。
message	文本	通知消息。
imageUrl	文本	附加到通知的自定义图片的 URL。
sendDate	日期时间	表示发送通知的时间。
type	整数	通知类型。可能的值： 0 - 常规通知 1 - 富媒体通知 2 - URL 通知 3 - 深层链接通知
bannerUrl	文本	包含 Android 横幅的 URL。
customData	键值记录列表	包含作为自定义数据传递的参数列表。
isRead	布尔值	如果收件箱通知已读，则为 True。
isActionPerformed	布尔值	如果执行了通知操作，则为True。对于常规通知，如果通知已读，则为true。对于富媒体，如果富媒体已呈现，则为true。对于 URL 和深层链接，如果 URL/深层链接已打开，则为true。

LoadMessages

从 Pushwoosh 获取收件箱通知。

输出参数

InboxMessages	InboxMessage 列表，所有收件箱消息的列表。
Success	如果一切正常，则返回 true，如果出现错误，则返回 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。

ReadMessage

将收件箱消息标记为已读。

输入参数

MessageCode	文本，InboxMessage 的代码（在 LoadMessages 中作为 InboxMessage 的参数接收）

输出参数

Success	如果一切正常，则为 True，如果出现错误，则为 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。

PerformAction

对指定的收件箱消息执行操作（例如，在浏览器中打开 URL）。

输入参数

MessageCode	文本，InboxMessage 的代码（在 LoadMessages 中作为 InboxMessage 的参数接收）

输出参数

Success	如果一切正常，则返回 true，如果出现错误，则返回 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。

DeleteMessage

从收件箱中删除消息。

输入参数

MessageCode	文本，InboxMessage 的代码（在 LoadMessages 中作为 InboxMessage 的参数接收）

输出参数

Success	如果一切正常，则返回 true，如果出现错误，则返回 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。

TotalMessagesCount

返回收件箱消息的总数。

输出参数

MessagesCount	整数，收件箱消息的总数。
Success	如果一切正常，则返回 true，如果出现错误，则返回 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。

UnreadMessagesCount

返回未读收件箱消息的数量。

输出参数

UnreadMessagesCount	整数，未读收件箱消息的数量。
Success	如果一切正常，则返回 true，如果出现错误，则返回 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。

MessagesWithNoActionPerformedCount

返回未执行操作的收件箱消息的数量。

输出参数

MessagesWithNoActionPerformedCount	整数，未执行操作的收件箱消息的数量。
Success	如果一切正常，则返回 true，如果出现错误，则返回 false。
Error	包含错误代码和错误消息的错误，其中包含可能发生的任何错误的详细信息。仅当 Success 输出参数为 false 时设置。