Struct

2026-07-06


ZPNsConfig	ZPNsMessage
ZPNsRegisterMessage

ZPNsConfig

ZPNs offline push configuration information.

Details

Description: Before using the offline push capability, developers need to fill in this configuration according to the configuration information obtained from each push vendor.

Declared in entity/ZPNsConfig.java

Properties

appType

public int appType

Push certificate configuration type.

enableHWPush

public boolean enableHWPush

Whether to enable Huawei push.

enableMiPush

public boolean enableMiPush

Whether to enable Xiaomi push.

enableVivoPush

public boolean enableVivoPush

Whether to enable VIVO push.

enableOppoPush

public boolean enableOppoPush

Whether to enable OPPO push.

enableFCMPush

public boolean enableFCMPush

Whether to enable FCM push.

miAppID

public String miAppID

If you need to enable Xiaomi push, please also fill in the appID obtained from the Xiaomi console.

miAppKey

public String miAppKey

If you need to enable Xiaomi push, please also fill in the appKey obtained from the Xiaomi console.

oppoAppID

public String oppoAppID

If you need to enable OPPO push, please also fill in the appID obtained from the OPPO console.

oppoAppSecret

public String oppoAppSecret

If you need to enable OPPO push, please also fill in the appSecret obtained from the OPPO console.

oppoAppKey

public String oppoAppKey

If you need to enable OPPO push, please also fill in the appKey obtained from the OPPO console.

vivoAppID

public String vivoAppID

If you need to enable VIVO push, please also fill in the appID obtained from the VIVO console.

vivoAppKey

public String vivoAppKey

If you need to enable VIVO push, please also fill in the appKey obtained from the VIVO console.

hwAppID

public String hwAppID

If you need to enable Huawei push, please also fill in the appID obtained from the Huawei console.

enableHWBadge

public boolean enableHWBadge

Whether to enable the Huawei app badge feature.

ZPNsMessage

ZPNs offline push message.

Details

Description: The message object delivered by the Zego server through the mobile vendor push channel, carrying the properties required for offline push.

Declared in entity/ZPNsMessage.java

Properties

title

public String title

Push title. Corresponds to the title field in the [ZIMPushConfig] object filled in when sending a message via ZIM.

content

public String content

Push content. Corresponds to the content field in the [ZIMPushConfig] object filled in when sending a message via ZIM.

payload

public String payload

Push extra content. Corresponds to the payload field in the [ZIMPushConfig] object filled in when sending a message via ZIM.

extras

public String extras

The original push payload content, containing all push information.

pushSourceType

public PushSource pushSourceType

Push source vendor type.

ZPNsRegisterMessage

ZPNs registration event information.

Details

Description: After the [registerPush] API call succeeds, developers can obtain the ZPNs registration result and information such as pushID here.

Declared in entity/ZPNsRegisterMessage.java

Properties

pushID

public String pushID

ZPNs push ID. The credential used to receive offline push notifications.

errorCode

public ZPNsErrorCode errorCode

Error code. 0 means success.

errorMessage

public String errorMessage

Error description information.

pushSourceType

public PushSource pushSourceType

Push vendor type.

deviceToken

public String deviceToken

The original push token information from the push vendor.