TIMMsgDelete

功能介绍

删除指定会话的本地消息

本接口会在删除本地消息的同时也会删除漫游消息。需要注意以下几点:

建议将之前的消息数组Json保存,然后删除的时候直接调用接口,避免构造消息数组。

一次最多只能删除 30 条消息。

一秒钟最多只能调用一次该接口。

如果该账号在其他设备上拉取过这些消息,那么调用该接口删除后,这些消息仍然会保存在那些设备上,即删除消息不支持多端同步。

参数详解

参数名称 参数类型 是否必填 描述
msgDeleteParams MsgDeleteParams 删除消息的参数

返回模板

Promise<commonResult<string>>

{
    code: TIMResult | TIMErrCode;
    desc?: string | undefined;
    json_param?: string | undefined;
    json_params?: string | undefined; // 兼容
    user_data?: string | undefined;
}

返回值详解

名称 数值类型 描述
code TIMResultTIMErrCode 返回状态码
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 { MsgDeleteParams,Json_value_msgdelete,MsgGetMsgListParams,Json_value_msg } from "im_electron_sdk/dist/interfaces";
let convId = ''
let convType=0
let param2:MsgGetMsgListParams = {
    conv_id:convId,
    conv_type: convType,
    params: {
        msg_getmsglist_param_last_msg: null,
        msg_getmsglist_param_count: 2,
        msg_getmsglist_param_is_ramble: true,
    },
    user_data: ""
}
let m = await timRenderInstance.TIMMsgGetMsgList(param2);
let json_msg_param:Json_value_msg = m.json_params[0];
let params : Json_value_msgdelete = {
    msg_delete_param_msg: json_msg_param,
    msg_delete_param_is_ramble: true    //选填
}

let param :MsgDeleteParams = {
    conv_id: convId,
    conv_type: convType,
    params: params,
    user_data: ''
}

const {code} = await timRenderInstance.TIMMsgDelete(param);
if(code == 0){
    // 成功
}

results matching ""

    No results matching ""