会话置顶,指的是把好友或者群会话固定在会话列表的最前面,方便用户查找。置顶状态会存储在服务器,切换终端设备后,置顶状态会同步到新设备上。
调用接口成功后会话列表重新排序,SDK 会派发事件 TIM.EVENT.CONVERSATION_LIST_UPDATED。
注意:v2.14.0起支持。置顶会话数上限50,不支持增加。
接口
tim.pinConversation(options);
参数 options 为 Object 类型,包含的属性值如下:
参数
Name | Type | Description |
---|---|---|
conversationID | String | 会话 ID。会话 ID 组成方式: |
isPinned | Boolean | true 表示置顶会话,false 表示取消置顶会话 |
返回值
Promise
对象。
示例
// 置顶会话,v2.14.0起支持
let promise = tim.pinConversation({ conversationID: 'C2CExample', isPinned: true });
promise.then(function(imResponse) {
// 置顶会话成功
const { conversationID } = imResponse.data; // 被置顶的会话 ID
}).catch(function(imError) {
console.warn('pinConversation error:', imError); // 置顶会话失败的相关信息
});
// 取消置顶会话,v2.14.0起支持
let promise = tim.pinConversation({ conversationID: 'C2CExample', isPinned: false });
promise.then(function(imResponse) {
// 取消置顶会话成功
const { conversationID } = imResponse.data; // 被取消置顶的会话 ID
}).catch(function(imError) {
console.warn('pinConversation error:', imError); // 取消置顶会话失败的相关信息
});
本页内容是否解决了您的问题?