Class
2026-07-06
| ZPNsManager |
ZPNsManager
详情
ZPNsManager SDK 主类。
方法
getVersion
static
getVersion
static getVersion(): string获取 SDK 版本号。
在 SDK 在运行过程中若遇到异常，可将问题、日志等信息提交 ZEGO 技术人员定位与排障。开发者也可通过该 API 收集当前 SDK 版本信息，便于 App 运营统计以及关联问题。
- 调用时机：任意时刻。
- 支持版本：1.0.0 及以上。
- 使用限制：无。
- 注意事项：无。
SDK 版本号。
getInstance
static
getInstance
static getInstance(): ZPNs获得 ZPNs 实例。
使用 ZPNs SDK 时，开发者应直接调用该 API 获取内部单例对象，而无需自行创建并且维护对象。
- 调用时机：任意时刻。
- 支持版本：2.0.0 及以上。
- 使用限制：无。
- 注意事项：使用 ZPNs 时需要通过此方法获取 ZPNs 单例对象。
SDK 单例对象，用于后续的 API 调用。
on<K extends keyof ZPNsEventHandler>
on<K extends keyof ZPNsEventHandler>
on<K extends keyof ZPNsEventHandler>(type: K, listener: ZPNsEventHandler[K]): void设置 ZPNs 推送事件通知回调。
参数
| 名称 | 类型 | 描述 |
|---|---|---|
| type | K | 事件类型。 |
| listener | ZPNsEventHandler[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 推送事件通知回调。
参数
| 名称 | 类型 | 描述 |
|---|---|---|
| type | K | 事件类型。 |
| listener | ZPNsEventHandler[K] | 事件产生后的自定义回调方法。 |
- 支持版本：2.0.0 及以上。
registerPush
registerPush
registerPush(config: ZPNsConfig): void该方法用于注册厂商离线推送。
参数
| 名称 | 类型 | 描述 |
|---|---|---|
| config | ZPNsConfig | ZPNs 注册配置。 |
详情
该方法用于注册厂商离线推送，注册结果将会在 [onRegistered] 方法中获取。
- 支持版本：2.0.0 及以上版本。
- 注意事项：无。
unregisterPush
unregisterPush
unregisterPush(): void不需要离线推送时可调用此方法反注册。
不需要离线推送时可调用此方法反注册。
- 业务场景：当用户点击应用程序内的关闭消息通知时可调用该方法反注册。
- 调用时机/通知时机：需要反注册时调用。
- 支持版本：2.0.0 及以上版本。
- 使用限制：需要在 [registerPush] 调用后才可调用。