删除会话
功能描述
在删除好友或退出群组后,如果不需要查看好友或群会话的历史消息,可以选择删除会话。
删除会话
注意
1. 删除会话默认不会多端同步,如果需要多端同步,您可以在 Chat Console 开启多端同步。开关路径:Applications > Your App > Chat > Configuration > Login and Message > Multi-client Synchronization Settings。
2. 支持批量删除会话(每次最多支持删除100个会话),同时可选择是否清空会话历史消息。
接口
chat.deleteConversation(conversationID);
参数
Name | Type | Description |
conversationID | String | 会话 ID。 会话 ID 组成方式: C2C${userID}(单聊) GROUP{groupID}(群聊) @TIM#SYSTEM(系统通知会话) |
返回值
Promise
示例
// 删除单一会话, 并清空会话历史消息let promise = chat.deleteConversation('C2CExample');promise.then(function(imResponse) {// 删除会话成功const { conversationID } = imResponse.data; // 被删除的会话 ID}).catch(function(imError) {console.warn('deleteConversation error:', imError); // 删除会话失败的相关信息});
// 删除单一会话, 不清空会话历史消息let promise = chat.deleteConversation({conversationIDList: ['C2CExample'], clearHistoryMessage: false});promise.then(function(imResponse) {// 删除会话成功const { conversationIDList } = imResponse.data; // 被删除的会话 ID 列表}).catch(function(imError) {console.warn('deleteConversation error:', imError); // 删除会话失败的相关信息});
// 删除多个会话, 并清空会话历史消息let promise = chat.deleteConversation({conversationIDList: ['C2CExample', 'GROUPExample']});promise.then(function(imResponse) {// 删除会话成功const { conversationIDList } = imResponse.data; // 被删除的会话 ID 列表}).catch(function(imError) {console.warn('deleteConversation error:', imError); // 删除会话失败的相关信息});
// 删除多个会话, 不清空会话历史消息let promise = chat.deleteConversation({conversationIDList: ['C2CExample', 'GROUPExample'], clearHistoryMessage: false});promise.then(function(imResponse) {// 删除会话成功const { conversationIDList } = imResponse.data; // 被删除的会话 ID 列表}).catch(function(imError) {console.warn('deleteConversation error:', imError); // 删除会话失败的相关信息});