tencent cloud

文档反馈

Web&小程序&uni-app

最后更新时间:2023-03-21 10:38:37

    功能描述

    清空消息会同时清空当前会话内所有的消息,包含本地和云端消息,但不会删除会话本身。

    说明:

    • 使用该接口需要将 SDK 版本升级至 v2.25.0 或更高版本。
    • 会话消息被清空后,unreadCount 被置为0,lastMessage 的内容同时被清空。
    • 该接口不支持清空话题(Topic)的消息。
    • 如果想清空消息同时删除会话,请使用 deleteConversation

    清空消息

    接口

    tim.clearHistoryMessage(conversationID);

    参数 conversationID 为 String 类型,如下:

    参数

    Name Type Description
    conversationID String 会话 ID。会话 ID 组成方式:
  • C2C${userID}(单聊)
  • GROUP{groupID}(群聊)
  • 返回值

    Promise 对象。

    示例

    // 清空单聊的本地及云端的消息
    let promise = tim.clearHistoryMessage('C2CExample');
    promise.then(function(imResponse) {
    // 清空消息成功
    }).catch(function(imError) {
    console.warn('clearHistoryMessage error:', imError); // 清空消息失败的相关信息
    });
    // 清空群聊的本地及云端的消息
    let promise = tim.clearHistoryMessage('GROUPExample');
    promise.then(function(imResponse) {
    // 清空消息成功
    }).catch(function(imError) {
    console.warn('clearHistoryMessage error:', imError); // 清空消息失败的相关信息
    });
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持