实时音视频

实时语音

超低延迟直播

即时通讯

互动核心产品

音视频通话 UIKit

互动直播 UIKit

语聊房 UIKit

IMKit

UIKits

超级白板

云端播放器

AI 美颜

云端录制

小游戏平台

本地服务端录制

星图

互动扩展服务

数字人 PaSS 服务

AIGC

数美内容审核

大饼 AI 变声

实时传译

云市场

产品

语聊房

秀场直播

在线 KTV

在线健身

互动播客

社交娱乐

小班课

大班课

在线音乐教学

在线美术教学

在线编程教学

在线教育

远程医疗

医疗健康

语音通话

视频通话

视频会议

协同办公

解决方案

控制台

安全合规

术语表

ZEGO 平台

通用文档

概述

计费说明

基本概念介绍

产品简介

下载

ZPNs

发布日志

升级指南

错误码

客户端 SDK

跑通示例代码

实现基本消息收发

快速开始

使用 Token 鉴权

用户管理

多端登录

离线登录

黑名单管理

好友管理

在线状态订阅

用户

房间管理

房间资料管理

房间属性管理

房间用户管理

房间

群组管理

群资料管理

群属性管理

群成员管理

群组

收发消息

获取历史消息

删除消息

插入本地消息

转发消息

撤回消息

消息回执

设置消息拓展字段

搜索本地消息

消息表态

导出导入消息

接收 Tips 消息

地理围栏

回复消息

消息

获取会话列表

管理消息未读数

设置会话免打扰

删除会话

置顶会话

查询会话

保存会话草稿

标记会话

会话

缓存管理

能力概述

实现流程

内容审核

呼叫邀请

实现离线推送

Apple 推送集成指南

小米推送集成指南

华为推送集成指南

OPPO 推送集成指南

vivo 推送集成指南

FCM 集成指南

Android 推送集成指南

resourcesID 说明

自定义通知铃声

自定义推送规则

获取 payload 字段

跨应用离线推送

实现 VoIP 通知

自定义通知图标

通知携带图片附件

替换通知

最佳实践

离线推送

功能指引

迁移方案

客户端 API

服务端 API

API 参考文档

常见问题

ZPNs supports offline push notification receiver app to update the app icon badge with the number of unread messages, reminding users of the unread message count.

# Modify a notification badge


## Overview

ZPNs supports offline push notification receiver app to update the app icon badge with the number of unread messages, reminding users of the unread message count.

## Prerequisites

- ZPNs SDK version 2.6.0 or above has been integrated and the function of offline push notification has been implemented. For details, please refer to this document [Implement offline push notification](./../Implement%20offline%20push%20notification.mdx).
- Android device or emulator with Android 9.0 or above version (real device is recommended).
- iOS device running iOS 11.0 or above.


<Tabs>
<Tab title="iOS">

### Report the badge number

When the receiving end is online, it needs to call the [setServerBadge](https://pub.dev/documentation/zego_zpns/latest/zego_zpns/ZPNs/setServerBadge.html) method to report the current badge number to the ZPNs server. When it receives a offline push notification, ZPNs will automatically update the badge number on the receiving end based on this value.

<Note title="说明">
The badge value must not be less than 0.
</Note>

```dart
// Report the badge number of the app as 1 to the ZPNs server.
ZPNs.getInstance().setServerBadge(1);
```

### Send offline push notifications with badge information

When sending messages or call invitations, the sender can modify the badge-related parameters in [ZIMPushConfig](https://pub.dev/documentation/zego_zim/latest/zego_zim/ZIMPushConfig-class.html) to determine the changes in the badge on the receiving end.

```dart
ZIMPushConfig pushConfig = ZIMPushConfig();
// Whether the push notification carries badge information, default is false.
pushConfig.enableBadge = true;
// The badge increment for the target of this push notification. Set it as 1 here, which will increase the badge number of the receiving end app by 1.
pushConfig.badgeIncrement = 1;
```

### Update the badge automatically

After receiving offline push notifications, the ZPNs SDK will automatically adjust the app icon badge based on the badge information in the notifications.

</Tab>
<Tab title="Android">

### Send offline push notifications with badge information

When sending messages or call invitations, the sender can modify the badge-related parameters in [ZIMPushConfig](https://pub.dev/documentation/zego_zim/latest/zego_zim/ZIMPushConfig-class.html) to determine the changes in the badge on the receiving end.

```dart
ZIMPushConfig pushConfig = ZIMPushConfig();
// Whether the push notification carries badge information, default is false.
pushConfig.enableBadge = true;
// The badge increment for the target of this push notification. Set it as 1 here, which will increase the badge number of the receiving end app by 1.
pushConfig.badgeIncrement = 1;
```

### Update the badge automatically

Starting from [Android 8.0 (API level 26)](https://developer.android.com/develop/ui/views/notifications/badges), the system will display a badge (a dot) by default after receiving a push notification from FCM.

<Frame width="128" height="auto" caption=""><img src="https://storage.zego.im/sdk-doc/Pics/ZIM/icon.png" /></Frame>

After clearing the notification in the notification bar, the badge will also be automatically cleared.

</Tab>
</Tabs>
