Class

2026-05-25


ZPNs	ZPNsEventHandler

ZPNs

方法

getInstance

static

getInstance

getInstance(): ZPNs

获得 ZPNs 实例。

获取 ZPNs 实例。

业务场景：使用 ZPNs 时需要通过此方法获取 ZPNs 单例对象。

支持版本：2.2.0 及以上版本。

ZPNs 实例对象。

setBackgroundMessageHandler

static

setBackgroundMessageHandler

setBackgroundMessageHandler(handler: (message: ZPNsMessage) => void): void

Android 平台 App 杀掉后，接收离线的静默推送通知。

参数

名称	类型	描述
handler	(message: ZPNsMessage) => void	接收离线的静默推送通知的函数。

详情

App 杀掉后，在非 UI 组件里设置回调，用来接收离线的静默推送通知。

使用限制：uni-app SDK 暂不支持该接口。

addLocalNotification

addLocalNotification(message: ZPNsLocalMessage): void

添加一条本地推送。

参数

名称	类型	描述
message	ZPNsLocalMessage	构造本地通知的消息对象。

详情

详细描述：当开发者的 App 位于前台或刚推到后台且未被冻结时，后台未感知到该用户已掉线的情况下不会发送离线推送。这时若开发者需要补推送通知的情况下，可以使用该接口手动为设备发送一条本地推送消息。

applyNotificationPermission

applyNotificationPermission(): void

向系统申请推送通知权限

向系统申请推送通知权限。若不调用该 API 或调用后用户选择了拒绝，则不会收到推送通知。建议在 App 打开时调用询问权限。

createNotificationChannel

createNotificationChannel(channel: ZPNsNotificationChannel): void

Android 平台时，创建一个通知通道。

参数

名称	类型	描述
channel	ZPNsNotificationChannel	构造通知通道的对象。

详情

Android 8.0 以及以上版本，可调用该 API 创建通知通道。详情可参考 Google 官方文档。

enableDebug

enableDebug(): void

是否开启调试模式

是否开启调试模式。若使用 iOS 调试证书进行开发，请设置为 true。

registerPush

registerPush(config: ZPNsRegisterConfig): void

该方法用于注册厂商离线推送。

参数

名称	类型	描述
config	ZPNsRegisterConfig	离线推送配置对象。

详情

该方法用于注册厂商离线推送。

业务场景：当开发者需要使用离线推送时可调用该方法。

支持版本：ZPNs 2.2.0 及以上版本。

setLocalBadge

setLocalBadge(badge: Number): void

设置 app 本地角标数。

参数

名称	类型	描述
badge	Number	需要设置的值。

详情

设置 app 本地角标数。支持苹果、华为、VIVO、OPPO 的相关 API。

业务场景：开发者需要修改本地角标数时调用。
默认值：无。

支持版本：ZPNs 2.6.0 及以上版本。
使用限制：uni-app SDK 暂不支持该接口。

setPushConfig

setPushConfig(config: ZPNsConfig): void

设置各家厂商的推送设置项。

参数

名称	类型	描述
config	ZPNsConfig	ZPNs 配置类。

详情

设置各家厂商的推送设置项。

业务场景：开发者需要使用该方法来设置厂商推送的配置。
调用时机/通知时机：需要设置厂商推送时调用。

支持版本：2.0.0 及以上版本。

setServerBadge

setServerBadge(badge: Number): void

通过该接口向 ZPNs 服务器上报当前 App 的角标数。

参数

名称	类型	描述
badge	Number	需要设置的值。

详情

通过该接口向 ZPNs 服务器上报当前 App 的角标数。当 App 离线后，ZPNs 将基于之前上报的角标数进行变更。

业务场景：当开发者本地角标发生变更时，调用该接口上报。
默认值：若接收端不上报当前角标数，则接收推送时，ZPNs 不会自动修改角标。
调用时机：任意时机可调用，但实际向后台上报时机在 pushID 注册成功并且用户登录后，登出前。

支持版本：ZPNs 2.6.0 及以上版本。
使用限制：暂时没有单接口限频。目前仅 iOS 端需要设置本接口。uni-app SDK 暂不支持该接口。
注意事项：badge 不可小于 0。

unregisterPush

unregisterPush(): void

不需要离线推送时可调用此方法反注册。

调用时机/通知时机：需要反注册时调用。

支持版本：ZPNs 2.5.0 及以上版本。
使用限制：需要在 [registerPush] 调用后才可调用。

ZPNsEventHandler

方法

notificationArrived

notificationArrived(message: ZPNsMessage): void

厂商通知展示回调。

参数

名称	类型	描述
message	ZPNsMessage	ZPNs 消息数据类.

详情

厂商通知展示回调。

通知时机：厂商通知展示回调触发时统一在此接口抛出。

支持版本：2.0.0 及以上版本。

notificationClicked

notificationClicked(message: ZPNsMessage): void

厂商通知点击回调。

参数

名称	类型	描述
message	ZPNsMessage	ZPNs 消息类对象。

详情

厂商通知点击回调。

通知时机：各厂商的通知点击回调，统一在此接口抛出。

支持版本：2.0.0 及以上版本。

registered

registered(message: ZPNsRegisterMessage): void

生成 PushID 后触发的回调。

参数

名称	类型	描述
message	ZPNsRegisterMessage	离线推送消息对象。

详情

实现该回调可以在 [registerPush] 调用后，会通过该回调返回 ZPNs 生成的 PushID。

业务场景：开发者在接入 SDK 后，若需要获得 PushID 可实现此回调。
通知时机：[registerPush] 调用后触发此通知。

支持版本：2.0.0 及以上版本。

throughMessageReceived

throughMessageReceived(message: ZPNsMessage): void

厂商透传消息回调。

参数

名称	类型	描述
message	ZPNsMessage	ZPNs 消息类。

详情

厂商透传消息回调。

业务场景：各厂商返回的透传消息都会触发该接口，并在此接口抛出通知。
通知时机：推送到达时存在透传消息触发。

支持版本：2.0.0 及以上版本。