TIMConvDelete
功能介绍
删除会话
此接口用于删除会话，删除会话是否成功通过回调返回。
在删除好友或退出群组后，如果不需要查看好友或群会话的历史消息，可以选择删除会话。
会话删除默认关闭多端同步，可在即时通信 IM 控制台 开启多端同步。
删除会话，会同时删除终端和服务器的历史消息，且无法恢复。
会话内的消息在本地删除的同时，在服务器也会同步删除。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| param | convDelete | 是 | 删除会话的参数 |
返回模板
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 { convDelete } from "im_electron_sdk/dist/interfaces";
let convID = ""
let convType = 0
let param:convDelete={
convId:convID, //必填， convID
convType:convType, //必填，convType，参考[TIMConvType]
userData:"", //选填
}
let {code} =await timRenderInstance.TIMConvDelete(param)
if(code ==0){
// 删除成功
}