TIMConvGetConvInfo
功能介绍
获取指定会话列表
本地存储的会话列表没有数量上限。
云端存储的会话列表最大数量为 100。如果您希望扩展此数量,可以升级旗舰版。旗舰版用户可以在控制台配置最高数量为 500。
长时间没有信息变更,该会话在云端最多保存 7 天。如需放宽限制,请 联系我们。
本地存储的会话和云端存储的会话并不总是一致的,如果用户不主动调用 deleteConversation 接口删除本地的会话,该会话就会一直存在。而云端存储的会话最大只会保存 100 条,且对于长时间没有信息变更的会话,云端最多保存 7 天,所以不同的终端本地显示的会话可能会不一样。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
param | convGetConvInfo | 是 | 获取指定会话列表的参数 |
返回模板
Promise<commonResult<Array<convInfo>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<convInfo> | undefined;
json_params?: Array<convInfo> | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | TIMResult | TIMErrCode | 返回状态码 |
desc | string | undefined | 返回描述 |
json_param | Array< convInfo > | undefined | 根据具具体接口返回 |
json_params | Array< convInfo > | undefined | 兼容的字段,某些情况下会返回这个,根据具体接口返回 |
user_data | string | undefined | ImSDK负责透传的用户自定义数据,未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { convItem,convGetConvInfo } from "im_electron_sdk/dist/interfaces";
let convID = ""
let convType = 0
let conv_item:convItem = {
get_conversation_list_param_conv_id:convID, //必填
get_conversation_list_param_conv_type: convType //必填
}
let param:convGetConvInfo = {
json_get_conv_list_param:[conv_item], //必填
user_data:"", //选填
}
let {code} = await timRenderInstance.TIMConvGetConvInfo(param)
if(code == 0){
// 获取成功
}