Pushwoosh Mendix 模块操作

用于 Mendix 的 Pushwoosh 模块在两个地方公开其功能：Pushwoosh 事件小部件，它启动 SDK 并将传入的通知转换为 nanoflow 事件；以及您可以从原生移动导航配置文件上的任何 nanoflow 调用的 JavaScript 操作。本页列出了这两者。

Pushwoosh 事件小部件属性

该小部件不渲染任何内容。只需在原生移动导航配置文件中首先加载的页面上放置一次即可。它会初始化 SDK，选择性地注册设备，并为每个推送通知事件触发一个 nanoflow。

设置

这些属性用于启动 SDK 并在其就绪时报告。

属性	功能
Application Code	您的应用的 Pushwoosh Application Code，例如 XXXXX-XXXXX。必需。
加载时注册	在小部件加载后立即注册设备。在 iOS 上，这会显示系统权限提示，因此如果您希望稍后使用 RegisterForPushNotifications 操作来请求权限，请关闭此选项。
初始化时	SDK 启动后运行一次的 nanoflow。
注册时	当设备获得 push token 时运行的 nanoflow。
Push token	在 On registered 运行之前，将 push token 写入的字符串属性。

推送事件

这些属性将传入的通知传递到您的模型中并触发一个 nanoflow。

属性	功能
Payload	接收完整通知 payload (JSON 格式) 的字符串属性。
消息	接收通知文本的字符串属性。
收到推送时	当应用在前台时收到通知时运行的 nanoflow。
打开推送时	当用户点击通知时运行的 nanoflow。

深度链接

这些属性处理携带应用内特定页面链接的通知。

属性	功能
Deep link	从通知中接收 deep link URL 的字符串属性。
处理深度链接时	当打开的通知携带链接时运行的 nanoflow。它在 On push opened 之外额外运行。

这些属性在 nanoflow 运行前被填充，因此 nanoflow 可以立即读取它们。

设置操作

当您自己启动 SDK 而不是使用小部件时，请使用这些操作。

Initialize

初始化 Pushwoosh SDK。在任何其他 Pushwoosh 操作之前调用一次，通常在主页的加载 nanoflow 中调用。当页面上有 Pushwoosh 事件小部件时，您不需要它，因为小部件会自行初始化 SDK。

在 Android 上，FCM Sender ID 来自 google-services.json，原生构建会拾取该文件。它不会传递给此操作。

参数	类型	描述
applicationCode	String	Pushwoosh Application Code，例如 XXXXX-XXXXX。必需。
notificationHandling	String	可选。default 或 manual。留空以使用默认行为。

返回一个布尔值，当 SDK 启动时为 true。

注册操作

这些操作控制此设备是否接收通知，并公开用于寻址该设备的标识符。

RegisterForPushNotifications

为设备注册推送通知并返回 push token。在 iOS 上，这会触发系统权限提示，因此请在流程中对用户来说请求权限合理的时机调用它。

返回一个包含 push token 的字符串。

UnregisterForPushNotifications

注销设备。设备将停止接收通知，直到再次调用 RegisterForPushNotifications。

返回一个字符串，其中包含设备注销时使用的 token。

GetPushToken

返回当前的 push token，如果设备尚未注册，则返回空字符串。

返回一个字符串。

GetHwid

返回设备的 HWID，即 Pushwoosh 用来寻址设备的标识符。使用它从 Pushwoosh Control Panel 或服务器 API 定位单个设备。

返回一个字符串。

用户身份操作

这些操作将设备与个人关联起来，以便一条消息可以送达该用户使用的所有设备。

SetUserId

将设备与用户关联。在登录后调用。

参数	类型	描述
userId	String	您自己的用户标识符。必需。

返回一个布尔值。

GetUserId

返回当前与设备关联的用户 ID，如果未设置则返回空字符串。

返回一个字符串。

SetEmails

向 Pushwoosh 注册用户的电子邮件地址，以便他们可以通过电子邮件和推送接收消息。

参数	类型	描述
emails	String	一个地址，或多个以逗号分隔的地址。必需。

返回一个布尔值。

Tag 操作

Tag 是在 Pushwoosh Control Panel 中构建 segment 所依据的设备属性。

SetTags

在设备上设置 Tag。

参数	类型	描述
tagsJson	String	一个 JSON 对象，例如 {"Language":"en","Level":7,"Premium":true}。必需。

返回一个布尔值。

Mendix 表达式中的引号

Mendix 表达式中的字符串用单引号括起来，因此其中的 JSON 会保持其双引号不被转义：'{"Language":"en"}'。在表达式内部写入 "" 或 \" 会产生一个操作无法解析的字符串。

GetTags

以 JSON 字符串的形式返回当前在设备上设置的 Tag。

返回一个字符串。

Event 操作

Event 是触发式营销活动和应用内消息的起点。

PostEvent

向 Pushwoosh 发布一个 Event。

参数	类型	描述
eventName	String	在 Control Panel 中配置的事件名称。必需。
attributesJson	String	可选。事件属性的 JSON 对象。

返回一个布尔值。

底层的 SDK 调用既不报告成功也不报告失败，因此一旦调用被传递给 SDK，该操作就会返回 true。

本地通知操作

本地通知由应用本身生成，无需网络，因此适合用于提醒。

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	可选。额外 HTTP 头的 JSON 对象。

一旦调用被传递给 SDK，就会返回一个布尔值。

SetShowForegroundAlert

控制当应用打开时到达的通知是否显示为系统警报。默认为开启，因此如果您想通过小部件的 On push received 事件自行处理前台通知，请关闭此选项。

参数	类型	描述
showAlert	Boolean	True 表示显示系统警报。必需。

一旦调用被传递给 SDK，就会返回一个布尔值。

仅限 iOS

Android SDK 不公开此设置，在 Android 上调用此操作会引发错误。请仅在 iOS 上调用它。

GetShowForegroundAlert

告知当应用打开时到达的通知是否将显示为系统警报。默认为开启。

返回一个布尔值。

仅限 iOS

Android SDK 不公开此设置，在 Android 上调用此操作会引发错误。请仅在 iOS 上调用它。

其他渠道操作

这些操作为用户注册 Pushwoosh 支持的除推送之外的其他消息渠道。

RegisterSmsNumber

注册用户的电话号码，以便 Pushwoosh 可以通过短信联系他们。

参数	类型	描述
phoneNumber	String	国际格式，例如 +31201234567。必需。

一旦调用被传递给 SDK，就会返回一个布尔值。

RegisterWhatsappNumber

注册用户的电话号码，以便 Pushwoosh 可以通过 WhatsApp 联系他们。

参数	类型	描述
phoneNumber	String	国际格式，例如 +31201234567。必需。

一旦调用被传递给 SDK，就会返回一个布尔值。