TIMMsgReportReaded
功能介绍
消息上报已读
message 可以填 NULL 空字符串指针或者""空字符串,此时以会话当前最新消息的时间戳(如果会话存在最新消息)或当前时间为已读时间戳上报.
当要指定消息时,则以该指定消息的时间戳为已读时间戳上报,最好用接收新消息获取的消息数组里面的消息Json或者用消息定位符查找到的消息Json,避免重复构造消息Json。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
msgReportReadedParams | MsgReportReadedParams | 是 | 消息上报已读的参数 |
返回模板
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 { MsgReportReadedParams,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 param : MsgReportReadedParams = {
conv_id: convId, //必填
conv_type: convType, //必填
json_msg_param: json_msg_param, //选填
user_data: '' //选填
}
const {code} = await timRenderInstance.TIMMsgReportReaded(param);
if(code == 0){
// 成功
}