浏览 SDKs · Android
平台
SDKsAndroid

置顶或取消置顶会话

设置指定会话在当前用户会话列表中的置顶状态。

复制

设置指定会话在当前登录用户会话列表中的置顶状态。置顶后的会话将固定排在会话列表前列。

OpenIMClient.getInstance().conversationManager.pinConversation(
    new OnBase<String>() {
        @Override
        public void onSuccess(String data) {
            // 请求已完成。
        }

        @Override
        public void onError(int code, String error) {
            // code 和 error 说明失败原因。
        }
    },
    conversationID,
    true
);

参数说明

参数类型是否必填说明
baseOnBase<String>是异步请求回调。
conversationIDString是目标会话的唯一标识。
isPinnedboolean是传入 true 表示置顶,传入 false 表示取消置顶。

返回结果

成功回调表示服务端已记录置顶状态。置顶设置仅影响当前登录用户的本地排序,不会影响对端用户或群内其他成员。

接口调用成功后,SDK 会触发 OnConversationListener.onConversationChanged 事件;客户端收到通知后应根据 conversationID 更新本地会话的 isPinned 属性并重新排序列表,完整监听配置请参考获取会话列表。