Class
2026-07-06
| ZPNsManager | ZPNsMessageReceiver |
ZPNsManager
详情
ZPNsManager SDK 主类。
Declared in ZPNsManager.java
方法
getVersion
getVersion
String getVersion()获取 SDK 版本号。
Declared in
ZPNsManager.java在 SDK 在运行过程中若遇到异常，可将问题、日志等信息提交 ZEGO 技术人员定位与排障。开发者也可通过该 API 收集当前 SDK 版本信息，便于 App 运营统计以及关联问题。
- 调用时机：任意时刻。
- 支持版本：1.0.0 及以上。
- 使用限制：无。
- 注意事项：无。
SDK 版本号。
setPushConfig
static
setPushConfig
void setPushConfig(ZPNsConfig config)设置各家厂商的推送设置项。
Declared in
ZPNsManager.java参数
| 名称 | 类型 | 描述 |
|---|---|---|
| config | ZPNsConfig | 推送设置 |
详情
设置各家厂商的推送设置项。
- 支持版本：2.0.0 及以上。
- 使用限制：开发者需要使用该方法来设置厂商推送的配置。
- 注意事项：需要设置厂商推送时调用。
getInstance
static
getInstance
ZPNsManager getInstance()获得 ZPNs 实例。
Declared in
ZPNsManager.java使用 ZPNs SDK 时，开发者应直接调用该 API 获取内部单例对象，而无需自行创建并且维护对象。
- 调用时机：任意时刻。
- 支持版本：2.0.0 及以上。
- 使用限制：无。
- 注意事项：使用 ZPNs 时需要通过此方法获取 ZPNs 单例对象。
SDK 单例对象，用于后续的 API 调用。
enableDebug
static
enableDebug
void enableDebug(boolean isDebug)是否开启调试模式。
Declared in
ZPNsManager.java参数
| 名称 | 类型 | 描述 |
|---|---|---|
| isDebug | boolean | 开关测试模式。 |
详情
是否开启调试模式。
- 支持版本：2.0.0 及以上。
setEventHandler
setEventHandler
void setEventHandler(ZPNsPushEventHandler handler)设置事件通知回调。
Declared in
ZPNsManager.java参数
| 名称 | 类型 | 描述 |
|---|---|---|
| handler | ZPNsPushEventHandler | 接收事件通知的函数。 |
详情
设置事件通知回调，用于监听 ZPNs 注册是否异常事件等回调。
- 支持版本：2.0.0 及以上。
- 使用限制：无。
- 注意事项：当多次调用该 API 传入不同的 eventHandler 对象时，最后一次的对象会覆盖前面设置过的对象；当该 API 传入的 eventHandler 对象为空时，则取消事件回调通知。
getPushConfig
getPushConfig
void getPushConfig()获取 PushConfig 配置类。
Declared in
ZPNsManager.java用于获取 PushConfig 数据类对象。
- 业务场景：开发者需要获得 PushConfig 数据类对象时可调用该方法。
- 调用时机/通知时机：无调用时机限制，开发者需要时可调用。
- 支持版本：2.0.0 及以上版本。
getZPNsMessage
getZPNsMessage
void getZPNsMessage()用户点击通知栏跳转 activity 时，可通过该接口获取 payload 等信息。
Declared in
ZPNsManager.java- 调用时机：在活动的 onCreate 或 onResume 方法中调用。
- 支持版本：2.5.0 及以上版本。
registerPush
registerPush
void registerPush(Application context)该方法用于注册厂商离线推送。
Declared in
ZPNsManager.java参数
| 名称 | 类型 | 描述 |
|---|---|---|
| context | Application | Application 上下文信息 |
详情
该方法用于注册厂商离线推送，注册结果将会在 [onRegistered] 方法中获取。
- 支持版本：2.0.0 及以上版本。
- 注意事项：无。
unregisterPush
unregisterPush
void unregisterPush()不需要离线推送时可调用此方法反注册。
Declared in
ZPNsManager.java不需要离线推送时可调用此方法反注册。
- 业务场景：当用户点击应用程序内的关闭消息通知时可调用该方法反注册。
- 调用时机/通知时机：需要反注册时调用。
- 支持版本：2.0.0 及以上版本。
- 使用限制：需要在 [registerPush] 调用后才可调用。
setApplicationIconBadgeNumber
setApplicationIconBadgeNumber
void setLocalBadge(Context context, int badge)设置 app 本地角标数。
Declared in
ZPNsManager.java参数
| 名称 | 类型 | 描述 |
|---|---|---|
| context | Context | Android 环境上下文。 |
| badge | int | 需要设置的值。 |
详情
设置 app 本地角标数。支持苹果、华为、VIVO、OPPO 的相关 API。
- 业务场景：开发者需要修改本地角标数时调用。
- 默认值：无。
- 支持版本：ZPNs 2.6.0 及以上版本。
- 使用限制：uni-app SDK 暂不支持该接口。
ZPNsMessageReceiver
详情
ZPNsManager SDK 事件处理类。
Declared in ZPNsMessageReceiver.java
方法
onRegistered
onRegistered
void onRegistered(Context context, ZPNsRegisterMessage message)SDK 注册推送结果回调。
Declared in
ZPNsMessageReceiver.java参数
| 名称 | 类型 | 描述 |
|---|---|---|
| context | Context | Android 环境上下文。 |
| message | ZPNsRegisterMessage | 注册结果内容。 |
详情
当注册离线推送服务时 SDK 生成 PushID 后触发的回调。
- 业务场景：开发者在接入 SDK 后，若需要获得 PushID 可实现此回调。
- 支持版本：2.0.0 及以上版本。
onNotificationClicked
onNotificationClicked
void onNotificationClicked()SDK 离线推送点击通知事件。
Declared in
ZPNsMessageReceiver.java当用户通过离线推送点击打开应用后，可以通过该回调获取到离线推送里的自定义内容。
- 业务场景：便于开发者在点击推送打开应用后获取自定义内容做业务页面跳转等操作。
- 支持版本：2.0.0 及以上版本。
- 使用限制：FCM 不直接支持，可以通过 data message 自行实现；Android 国内厂商需在官网控制台配置“自定义点击跳转”后生效。
onNotificationArrived
onNotificationArrived
void onNotificationArrived()SDK 离线推送到达通知事件。
Declared in
ZPNsMessageReceiver.javaonThroughMessageReceived
onThroughMessageReceived
void onThroughMessageReceived()SDK 离线推送静默通知事件。
Declared in
ZPNsMessageReceiver.java厂商透传消息回调。
- 业务场景：用于开发者希望在应用在后台期间能够收到静默推送从而执行业务逻辑的场景（如绘制通话接听 UI 等）。
- 支持版本：2.0.0 及以上版本。
- 使用限制：仅 FCM 支持。