删除会话

删除指定会话

通过调用 removeConversation 方法，删除指定会话。

提示

• 5.26.0 版本开始，该接口可用于删除超级群会话。
• 5.26.2 版本开始，新增 deleteRemotely 参数，可用于在 Electron 平台下同步删除远端服务器会话数据。

参数说明

参数	类型	必填	说明
conversation	IConversationOption	是	目标会话
deleteRemotely	Boolean	否	是否同步删除远端服务器会话，仅对 Electron 平台有效。从 5.26.2 版本开始支持。

示例代码

JavaScript

const conversation = {
    conversationType: RongIMLib.ConversationType.PRIVATE,
    targetId: '接收方的 userId',
}

RongIMLib.removeConversation(conversation).then(res => {
    // 删除指定会话成功
    if(res.code === 0){
        console.log(res.code)
    } else {
        console.log(res.code, res.msg)
    }
})

批量删除会话

5.26.0 版本 SDK 新增 batchDeleteConversations 接口，可用于批量删除本地、远端会话及会话中的历史消息。

参数说明

参数	类型	必填	说明
params	ConversationBatchDeletionParams	是

示例代码

JavaScript

const params = {
    identifiers: [
        {
            conversationType: RongIMLib.ConversationType.PRIVATE,
            targetId: '<目标会话 ID>'
        },
        {
            conversationType: RongIMLib.ConversationType.GROUP,
            targetId: '<目标会话 ID>'
        },
    ],
    deleteRemotely: true, // 非 Electron 平台下本地无存储数据，该参数无效，SDK 将删除服务器端会话
    deleteMessages: false, // 是否同步删除会话下的历史消息
};

RongIMLib
    .batchDeleteConversations(params)
    .then(res => {
        if (res.isOk) {
            console.log('删除成功！')
        } else {
            console.log('删除失败：'， res.code, res.msg)
        }
    })