logo文档中心
登录/注册控制台
文档
ZIM 客户端 API
ZPNs 客户端 API
ZIM Audio 客户端 API
服务端 API
即时通讯
React Native: TS
功能总览
全部分类
Class
Interface
Enum
当前页

Class

2026-07-06
ZPNsManagerZPNsEventHandler
ZPNsMessageReceiver

ZPNsManager

详情

ZPNsManager SDK 主类。

方法

getVersion

static
getVersion
static getVersion(): string
获取 SDK 版本号。

在 SDK 在运行过程中若遇到异常，可将问题、日志等信息提交 ZEGO 技术人员定位与排障。开发者也可通过该 API 收集当前 SDK 版本信息，便于 App 运营统计以及关联问题。

  • 调用时机：任意时刻。
  • 支持版本：1.0.0 及以上。
  • 使用限制：无。
  • 注意事项：无。

SDK 版本号。

setPushConfig

static
setPushConfig
static setPushConfig(config: ZPNsConfig): void
设置各家厂商的推送设置项。

参数

名称类型描述
configZPNsConfig推送设置

详情

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

  • 支持版本：2.0.0 及以上。
  • 使用限制：开发者需要使用该方法来设置厂商推送的配置。
  • 注意事项：需要设置厂商推送时调用。

getInstance

static
getInstance
static getInstance(): ZPNs
获得 ZPNs 实例。

使用 ZPNs SDK 时，开发者应直接调用该 API 获取内部单例对象，而无需自行创建并且维护对象。

  • 调用时机：任意时刻。
  • 支持版本：2.0.0 及以上。
  • 使用限制：无。
  • 注意事项：使用 ZPNs 时需要通过此方法获取 ZPNs 单例对象。

SDK 单例对象，用于后续的 API 调用。

setBackgroundMessageHandler

static
setBackgroundMessageHandler
static setBackgroundMessageHandler(handler: ZPNsBackgroundMessageHandler): void
Android 平台 App 杀掉后，接收离线的静默推送通知。

参数

名称类型描述
handlerZPNsBackgroundMessageHandler接收离线的静默推送通知的函数。

详情

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

  • 支持版本：2.0.0 及以上。
  • 使用限制：仅支持 FCM 离线推送。
  • 注意事项：uni-app SDK 暂不支持该接口。

enableDebug

static
enableDebug
static enableDebug(isDebug: boolean): void
是否开启调试模式。

参数

名称类型描述
isDebugboolean开关测试模式。

详情

是否开启调试模式。

  • 支持版本：2.0.0 及以上。

on<K extends keyof ZPNsEventHandler>

on<K extends keyof ZPNsEventHandler>
on<K extends keyof ZPNsEventHandler>(type: K, listener: ZPNsEventHandler[K]): void
设置 ZPNs 推送事件通知回调。

参数

名称类型描述
typeK事件类型。
listenerZPNsEventHandler[K]事件产生后的自定义回调方法。

详情

设置事件通知回调，用于监听 ZPNs 注册成功事件、推送点击等回调。

  • 支持版本：2.0.0 及以上。
  • 使用限制：无。

off<K extends keyof ZPNsEventHandler>

off<K extends keyof ZPNsEventHandler>
off<K extends keyof ZPNsEventHandler>(type: K, listener: ZPNsEventHandler[K]): void
取消设置 ZPNs 推送事件通知回调。

参数

名称类型描述
typeK事件类型。
listenerZPNsEventHandler[K]事件产生后的自定义回调方法。
  • 支持版本：2.0.0 及以上。

registerPush

registerPush
registerPush(config: ZPNsRegisterConfig): void
该方法用于注册厂商离线推送。

参数

名称类型描述
configZPNsRegisterConfigZPNs 注册配置。

详情

该方法用于注册厂商离线推送，注册结果将会在 [onRegistered] 方法中获取。

  • 支持版本：2.0.0 及以上版本。
  • 注意事项：无。

unregisterPush

unregisterPush
unregisterPush(): void
不需要离线推送时可调用此方法反注册。

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

  • 业务场景：当用户点击应用程序内的关闭消息通知时可调用该方法反注册。
  • 调用时机/通知时机：需要反注册时调用。
  • 支持版本：2.0.0 及以上版本。
  • 使用限制：需要在 [registerPush] 调用后才可调用。

applyNotificationPermission

applyNotificationPermission
applyNotificationPermission(): void
向系统申请推送通知权限

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

createNotificationChannel

createNotificationChannel
createNotificationChannel(channel: ZPNsNotificationChannel): void
Android 平台时，创建一个通知通道。

参数

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

详情

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

addLocalNotification

addLocalNotification
addLocalNotification(request: UNNotificationRequest *, message: ZPNsLocalMessage): void
添加一条本地推送。

参数

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

setLocalBadge

setLocalBadge
setLocalBadge(badge: number): void
设置 app 本地角标数。

参数

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

详情

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

  • 业务场景：开发者需要修改本地角标数时调用。
  • 默认值：无。
  • 支持版本：ZPNs 2.6.0 及以上版本。
  • 使用限制：uni-app SDK 暂不支持该接口。

setServerBadge

setServerBadge
setServerBadge(badge: number): void
通过该接口向 ZPNs 服务器上报当前 App 的角标数。

参数

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

详情

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

  • 业务场景：当开发者本地角标发生变更时，调用该接口上报。
  • 默认值：若接收端不上报当前角标数，则接收推送时，ZPNs 不会自动修改角标。
  • 调用时机：任意时机可调用， 但实际向后台上报时机在 pushID 注册成功并且用户登录后，登出前。
  • 支持版本：ZPNs 2.6.0 及以上版本。
  • 使用限制：暂时没有单接口限频。目前仅 iOS 端需要设置本接口。uni-app SDK 暂不支持该接口。
  • 注意事项：badge 不可小于 0。

ZPNsEventHandler

详情

方法

registered

registered
onRegistered(): void
SDK 注册推送结果回调。

当注册离线推送服务时 SDK 生成 PushID 后触发的回调。

  • 业务场景：开发者在接入 SDK 后，若需要获得 PushID 可实现此回调。
  • 支持版本：2.0.0 及以上版本。

ZPNsMessageReceiver

详情

ZPNsManager SDK 事件处理类。

方法

notificationClicked

notificationClicked
onNotificationClicked(): void
SDK 离线推送点击通知事件。

当用户通过离线推送点击打开应用后，可以通过该回调获取到离线推送里的自定义内容。

  • 业务场景：便于开发者在点击推送打开应用后获取自定义内容做业务页面跳转等操作。
  • 支持版本：2.0.0 及以上版本。
  • 使用限制：FCM 不直接支持，可以通过 data message 自行实现；Android 国内厂商需在官网控制台配置“自定义点击跳转”后生效。

notificationArrived

notificationArrived
onNotificationArrived(): void
SDK 离线推送到达通知事件。

当厂商通知到达展示时，将会触发此回调。

  • 业务场景：用于开发者选择是否在应用前台展示推送或者自定义推送的基础行为。
  • 支持版本：2.0.0 及以上版本。
  • 使用限制：仅 iOS 平台支持。

throughMessageReceived

throughMessageReceived
onThroughMessageReceived(): void
SDK 离线推送静默通知事件。

厂商透传消息回调。

  • 业务场景：用于开发者希望在应用在后台期间能够收到静默推送从而执行业务逻辑的场景（如绘制通话接听 UI 等）。
  • 支持版本：2.0.0 及以上版本。
  • 使用限制：仅 FCM 支持。

上一篇

功能总览

下一篇

Interface

当前页

返回到顶部