TIMConvGetUnreadMessageCountByFilter
功能介绍
根据 filter 获取未读总数
未读总数会减去设置为免打扰的会话的未读数，即消息接收选项设置为 kTIMRecvMsgOpt_Not_Receive 或 kTIMRecvMsgOpt_Not_Notify 的会话。
TIMConversationListFilter 中不要填写next_seq 和 count部分
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| TIMConversationListFilter | TIMConversationListFilter | 是 | 获取未读总数的filter 参数 |
返回模板
Promise<commonResult<totalUnreadCountResult>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: totalUnreadCountResult | undefined;
json_params?: totalUnreadCountResult | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | totalUnreadCountResult ｜ undefined | 根据具具体接口返回 |
| json_params | totalUnreadCountResult ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
let param:TIMConversationListFilter = {
params: {
conversation_list_filter_conv_type:null,
conversation_list_filter_mark_type: 0x1,
conversation_list_filter_conversation_group: null
}
}
timRenderInstance.TIMConvGetUnreadMessageCountByFilter(param)