TIMMsgClearHistoryMessage
功能介绍
清空指定会话的消息
会话内的消息在本地删除的同时，在服务器也会同步删除。
如果不想清空云端消息，请不要使用本接口。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| msgClearHistoryMessageParams | MsgClearHistoryMessageParams | 是 | 清空指定会话的消息的参数 |
返回模板
Promise<commonResult<string>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: string | undefined;
json_params?: string | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | string ｜ undefined | 根据具具体接口返回 |
| json_params | string ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { MsgClearHistoryMessageParams } from "im_electron_sdk/dist/interfaces";
let convId = ''
let convType=0
let param:MsgClearHistoryMessageParams = {
conv_id: convId,
conv_type: convType,
user_data: ''
}
const {code} = await timRenderInstance.TIMMsgClearHistoryMessage(param);
if(code == 0){
// 成功
}