浏览 SDKs · Android
平台
SDKsAndroid商业版

置顶或取消置顶消息

设置会话消息的置顶状态,并处理置顶消息变化事件。

复制

在会话中置顶重要消息或取消已置顶的消息。置顶状态为会话级共享属性,群聊中通常由群主或管理员操作,置顶后各成员端均可在聊天窗口顶部常驻显示该消息。

String conversationID = "g_group_123";
String clientMsgID = "msg_001";
boolean isPinned = true; // true 置顶,false 取消置顶

OpenIMClient.getInstance().messageManager.setConversationPinnedMsg(
    new OnBase<String>() {
        @Override
        public void onSuccess(String data) {
            // 置顶状态设置成功
        }

        @Override
        public void onError(int code, String error) {
            // 处理设置失败
        }
    },
    conversationID,
    clientMsgID,
    isPinned
);

参数说明

参数类型是否必填说明
baseOnBase<String>是异步请求回调。
conversationIDString是目标会话全局唯一 ID。
clientMsgIDString是待置顶或取消置顶的目标消息客户端 ID。
isPinnedboolean是是否置顶:true 为置顶消息,false 为取消置顶。

返回结果

成功回调中的 data 返回确认信息。

监听置顶变更事件

置顶状态发生变更后,会话成员端将通过 OnAdvanceMsgListener.onChangedPinnedMsg 接收更新事件:

@Override
public void onChangedPinnedMsg(ChangedPinnedMsg event) {
    // event.getConversationID() 对应会话
    // event.getMsgs() 为当前会话最新的置顶消息列表
}

如需主动获取当前会话的全部置顶消息,请参阅查询会话置顶消息。