Docs Overview/
Chat/
All_Platform/
Push Service/
Advanced Features/
Custom Definition Badge/

Custom Definition Badge

Android
iOS
Flutter
uni-app

Supported Vendors

Huawei.

Configuration Method

To configure the Huawei badge parameters in the console, set them to the application's startup class, for example, "com.tencent.qcloud.tim.demo.SplashActivity". The component will automatically parse and update the badge; otherwise, it will not update the badge.



By default, when the App goes into the background, the IMSDK will set the total number of unread IM messages as the badge. If the App is integrated with offline push, when a new offline push notification is received, the App badge will increment by 1 based on the baseline badge (default is the total number of unread IM messages, or the custom-defined badge if one has been set).

Configuration Method

If you want to customize the badge, follow these steps:
1. The App calls the - (void)setAPNSListener:(id<V2TIMAPNSListener>)apnsListener interface to set the listener.
2. The App implements the - (uint32_t)onSetAPPUnreadCount interface and returns the custom-defined badge number.
// 1. Set the listener
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Listen for push notifications
    [V2TIMManager.sharedInstance setAPNSListener:self];
    // Listen for unread conversation counts
    [[V2TIMManager sharedInstance] setConversationListener:self];
    return YES;
}

// 2. Save the unread count after it changes
- (void)onTotalUnreadMessageCountChanged:(UInt64)totalUnreadCount {
    self.unreadNumber = totalUnreadCount;
}

// 3. Report custom-defined unread count after the app is pushed to the background
/** After the application enters the background, customize the app's unread count. If not handled, the default app unread count is the sum of all conversation unread counts
 *  <pre>
 *
 *   - (uint32_t)onSetAPPUnreadCount {
 *       return 100;  // Custom-defined unread count
 *   }
 *
 *  </pre>
 */
- (uint32_t)onSetAPPUnreadCount {
    // 1. Get the custom-defined badge
    uint32_t customBadgeNumber = ...
    
    // 2. Add the IM message unread count
    customBadgeNumber += self.unreadNumber;
    
    // 3. Report to the IM server via IMSDK
    return customBadgeNumber;
}
Please refer to Android and iOS for configuration. The methods called have the same names in the Flutter version of the IM SDK.

Supported Vendors

Huawei.

Configuration Method

Step 1. Configure the Huawei badge parameters in the console to the application's startup class.

Note:
The startup class for the uniapp application is io.dcloud.PandoraEntry.




Step 2. Listen to changes in the total unread count of the Chat SDK to set the badge quantity.

1. Listen to the Chat SDK total unread message count updates through TOTAL_UNREAD_MESSAGE_COUNT_UPDATED.
2. Set the badge number through plus.runtime.setBadgeNumber.
let onTotalUnreadMessageCountUpdated = function(event) {
  const unreadCount = event.data; // Total unread count of the current session
  plus.runtime.setBadgeNumber(unreadCount); // Set the badge number
};
chat.on(TencentCloudChat.EVENT.TOTAL_UNREAD_MESSAGE_COUNT_UPDATED, onTotalUnreadMessageCountUpdated);