TIMConvCleanConversationUnreadMessageCount
功能介绍
清理回话的未读消息计数
当您想清理所有单聊会话的未读消息计数，conversation_id 请传入 "c2c"，即不指定具体的 userID
当您想清理所有群聊会话的未读消息计数，conversation_id 请传入 "group"，即不指定具体的 groupID
当您想清理所有会话的未读消息计数，conversation_id 请传入 "" 或者 null
该接口调用成功后，SDK 会通过 onConversationChanged 回调将对应会话的最新未读数通知给您
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| CleanUnreadMessageCoutParam | CleanUnreadMessageCoutParam | 是 | 清理回话的未读消息计数 |
返回模板
Promise<commonResult<Array<TIMConversationOperationResult>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<TIMConversationOperationResult> | undefined;
json_params?: Array<TIMConversationOperationResult> | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | Array< TIMConversationOperationResult > ｜ undefined | 根据具具体接口返回 |
| json_params | Array< TIMConversationOperationResult > ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
let param :CleanUnreadMessageCoutParam = {
conversation_id: "c2c_test",
clean_timestamp: 0,
clean_sequence: 0
}
timRenderInstance.TIMConvCleanConversationUnreadMessageCount(param)