升级说明

关于停止维护 IMLib v2 旧版 SDK 的声明

注意

• Web IMLib v2 版本目前已停止维护，建议您优先选择最新的 IMLib 版本。
• 已集成 IMLib v2 版本的用户，转为使用 Adapter 方式进行支持。集成旧版 2x SDK 的客户可以通过 RongIMLib-v2-Adapter 无缝替换升级。
• 未来我们将在 RongIMLib-v2-Adapter 上进行问题修复，但不会增加新功能。

IMLib 2.x 替换为 v2-adapter

NPM 包变更

原 @rongcloud/imlib-v2 包已停止维护，请使用 @rongcloud/imlib-v2-adapter 替代。

# 移除旧版本依赖
npm rm @rongcloud/imlib-v2 @rongcloud/engine
# 安装 RongIMLib-v2-Adapter
npm install @rongcloud/engine@latest @rongcloud/imlib-v2-adapter@latest -S

同时需要在集成代码中修改包引用。

// import * as RongIMLib from '@rongcloud/imlib-v2' 需修改为
import * as RongIMLib from '@rongcloud/imlib-v2-adapter'

// const RongIMLib = require('@rongcloud/imlib-v2') 需修改为
const RongIMLib = require('@rongcloud/imlib-v2-adapter')

CDN 链接引入

原 RongIMLib-2.x.x.prod.js SDK 已停止维护，请使用 RongIMLib-v2-Adapter 的最新版本替代。

RongIMLib-v2-Adapter 的最新版本可参见引入 SDK。

关于 v2.5 及更早版本的升级说明

IMLib 2.5 及更早版本，需注意如下变更：

1. SDK 不再支持公众号与客服插件相关接口！
2. IM 链接因网络问题意外中断后，SDK 会自动重连，应用层无需再调用 reconnect 方法。
3. 若 'RC:ProfileNtf'、'RC:CmdNtf'、'RC:InfoNtf' 类型消息的 content.data 字段为 Json 字符串，需自行解析。
4. SDK 不再兼容 IE 浏览器 6 至 8 版本！

废弃功能

会话

废弃功能

因本地存储不准确，不再维护以下会话相关接口

废弃方法	描述
getConversationUnreadCount	按会话类型获取会话未读数
clearConversations	按会话类型删除会话
clearTotalUnreadCount	清除所有会话未读数

兼容方法

getConversationUnreadCount 兼容示例代码

// 1、调用 getConversationList 方法获取所有会话
var targetTypes = [1,3]; //目标会话类型
var callback = {
    onSuccess: function(list) {
      // 2、根据返回的会话列表中 conversationType 方法字段筛选出目标会话
      var targetConvers = list.filter(function(conver) {
        return targetTypes.indexOf(conver.conversationType.toString()) > -1
      });
      // 3、根据筛选出的会话计算未读数
      var targetUnreadCount = 0
      targetConvers.forEach(function(conver) {
        targetUnreadCount += conver.unreadMessageCount
      });
      console.log('按会话类型获取会话未读数成功', targetUnreadCount);
    },
    onError: function(error) {
      console.log('获取会话列表失败', error);
  }
}
RongIMClient.getInstance().getConversationList(callback, null, 1000);

clearConversations 兼容示例代码

// 1、调用 `getConversationList` 方法获取所有会话
var targetTypes = [1,3]; //目标会话类型
var callback = {
  onSuccess: function(list) {
    // 2、根据返回的会话列表中 `conversationType` 字段筛选出目标会话
    var targetConvers = list.filter(function(conver) {
      return targetTypes.indexOf(conver.conversationType) > -1
    });
    // 3、循环调用 removeConversation 方法删除会话
    var targetUnreadCount = 0
    targetConvers.forEach(function(conver) {
      RongIMClient.getInstance().removeConversation(conver.conversationType, conver.targetId, { onSuccess: function () { }, onError: function () { } });
    });
    console.log('按会话类型删除会话成功');
  },
  onError: function(error) {
    console.log('获取会话列表失败', error);
  }
}
RongIMClient.getInstance().getConversationList(callback, null, 1000);

clearTotalUnreadCount 兼容示例代码

// 1、调用 `getConversationList` 方法获取所有会话
var targetTypes = [1,3]; //目标会话类型
var callback = {
  onSuccess: function(list) {
    // 2、循环调用 `clearUnreadCount` 方法清除未读数
    list.forEach(function(conver) {
      RongIMClient.getInstance().clearUnreadCount(conver.conversationType, conver.targetId, { onSuccess: function () { }, onError: function () { } });
    });
    console.log('按会话类型删除会话成功');
  },
  onError: function(error) {
    console.log('获取会话列表失败', error);
  }
}
RongIMClient.getInstance().getConversationList(callback, null, 1000);

讨论组

废弃功能

废弃讨论组相关接口

废弃方法	描述
createDiscussion	创建讨论组
getDiscussion	获取讨论组信息
quitDiscussion	退出讨论组
addMemberToDiscussion	加入讨论组
removeMemberFromDiscussion	将指定成员移除讨论租
setDiscussionInviteStatus	设置讨论组邀请状态
setDiscussionName	设置讨论组名称