setAppBadge
功能介绍
说明
设置App未读数角标,用于离线推送时展示未读数角标。
注意
目前仅firebase生效。
- iOS
- Flutter
- uni-app
- React-Native
函数原型
Future setAppBadge(int count, {
String? operationID,
});
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
count | int | 是 | 角标数 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
then | void | 调用成功回调 |
onError | Function | 调用失败回调 |
代码示例
OpenIM.iMManager.messageManager.setAppBadge();
函数原型
- (void)setAppBadge:(NSInteger)count
onSuccess:(nullable OIMSuccessCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
count | NSInteger | 是 | 角标数 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
onSuccess | OIMSuccessCallback | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
代码示例
[OIMManager.manager setAppBadge:0
onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
参数详解
参数详解
函数原型
IMSDK.asyncApi('setAppBadge', operationID: string, badge: number): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
badge | number | 是 | 角标数 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('setAppBadge', IMSDK.uuid(), 99)
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.setAppBadge(appUnreadCount: number, operationID: string): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
badge | number | 是 | 角标数 |
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.setAppBadge(99, 'operationID')
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});