TIMConvPinConversation
功能介绍
设置会话置顶
会话的顺序，按Conversation 对象的 orderKey 字段排序。orderKey 字段是整型数，当发送新消息、接收新消息、设置草稿或置顶会话时，会话被激活，orderKey 字段会增大。
需要注意的是，被置顶会话始终排在非置顶会话的前面，如果同时置顶多个会话，这几个会话之间的相对顺序仍然会保持，例如，有 5 个依次排序的会话 1、2、3、4、5，同时置顶会话 2 和 3，置顶后的顺序是 2、3、1、4、5，显然，会话 2 和 3 排在最前面，并且会话 2 仍然排在 3 的前面。
调用 TIMConvGetConvList 获取会话列表时，该接口会先返回置顶的会话，再返回未置顶的会话。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| param | convPinConversation | 是 | 设置会话置顶的参数 |
返回模板
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 { convPinConversation } from "im_electron_sdk/dist/interfaces";
let convId = ""
let convType = 0
let isPinned = true
let param:convPinConversation = {
convId:convId, //必填
convType:convType, //必填
isPinned:isPinned, //必填
user_data:'', //选填
}
let {code} = await timRenderInstance.TIMConvPinConversation(param)
if(code == 0){
//操作成功
}