文档导航
Web
SDK 版本:  5.X
公告:融云新文档中心已上线,欢迎到新文档中心阅读 Web IMLibWeb IMKit 的文档。

2.X 升级到 5.X(Web)

更新时间:2023-12-14 PDF

本文描述如何从 IMLib SDK 2.X 版本(@rongcloud/imlib-v2) 升级至 5.X 版本的步骤。

Web 平台升级概述

IMLib SDK 5.X 是即时通讯业务客户端 SDK 的最新版本, 对 Typescript 的使用者提供了友好的类型化支持。相对于 2.X 版本,5.X 版本功能更丰富,更稳定,并在之前版本上修复了大量问题,我们建议融云客户尽早升级至新版 IMLib SDK。

提示

融云同时为已集成 IMLib v2 版本(@rongcloud/imlib-v2)的客户提供了基于 Adapter 库(RongIMLib-v2-Adapter)替换升级选项。请注意,Adapter 库仅会提供问题修复,但不会在旧版 SDK 基础上增加新功能。详见关于 Adapter 的说明

评估升级工作量

IMLib 5x SDK 与旧版 SDK 不兼容。我们整理了新旧版本 SDK API 对应关系与差异。请开发者根据自身 API 使用情况与 API 差异,合理安排开发周期。

  • 新旧版本接口接口的名称参数差异较大。升级前需要详细对照。
  • 新旧版本接口返回值差异较大,可根据接口名称速查对照表比对各个接口返回值差异。

从 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 清除所有会话未读数
讨论组 createDiscussion 创建讨论组
讨论组 getDiscussion 获取讨论组信息
讨论组 quitDiscussion 退出讨论组
讨论组 addMemberToDiscussion 加入讨论组
讨论组 removeMemberFromDiscussion 将指定成员移除讨论租
讨论组 setDiscussionInviteStatus 设置讨论组邀请状态
讨论组 setDiscussionName 设置讨论组名称

新旧 API 对照速查表

描述 2.x API 5.x API
初始化 init init
设置监听 setConnectionStatusListener addEventListener
重连 reconnect 无需应用侧调用重连,详见SDK 重连机制
断开连接 disconnect disconnect
退出登录 logout disconnect
获取会话列表 getConversationList getConversationList
清除会话列表 clearConversations 5.X 版本客户端不提供该接口。
获取指定会话 getConversation getConversation
删除指定会话 removeConversation removeConversation
获取草稿 getTextMessageDraft getTextMessageDraft
保存草稿 saveTextMessageDraft saveTextMessageDraft
删除草稿 clearTextMessageDraft clearTextMessageDraft
获取所有会话未读数 getTotalUnreadCount getTotalUnreadCount
获取单个会话未读数 getUnreadCount getUnreadCount
按会话类型获取未读数 getConversationUnreadCount getTotalUnreadCount
清除单个会话未读数 clearUnreadCount clearMessagesUnreadStatus
清除全部会话未读数 clearAllUnreadCount clearAllMessagesUnreadStatus
会话置顶 setConversationStatus setConversationToTop
会话免打扰 setConversationStatus setConversationNotificationLevel
创建标签 createTag addTag
移除标签 removeTag removeTag
编辑标签 updateTag updateTag
获取标签列表 getTagList getTags
添加会话到一个标签 addTagForConversations addConversationsToTag
删除指定标签中某些会话 removeTagForConversations removeTagsFromConversations
删除指定会话中的某些标签 removeTagsForConversation removeTagsFromConversation
获取指定会话下的所有标签 getTagsForConversation getTagsFromConversation
分页获取指定标签下的会话列表 getConversationListByTag getConversationsFromTagByPage
按标签获取未读消息数 getUnreadCountByTag getUnreadCountByTag
设置标签中会话置顶 setConversationStatusInTag setConversationToTopInTag
发送消息 sendMessage sendMessage
注册自定义消息 registerMessageType registerMessageType
历史消息获取 getHistoryMessages getHistoryMessages
单聊消息回执 实现方案需要整体替换成 5x SDK 的接口 sendReadReceiptMessage
群聊消息回执 实现方案需要整体替换成 5x SDK 的接口 sendReadReceiptRequestsendReadReceiptResponseV2
消息撤回 sendRecallMessage recallMessage
消息删除 deleteRemoteMessages deleteMessages
更新消息扩展 updateMessageExpansion updateMessageExpansion
删除消息扩展 removeMessageExpansionForKey removeMessageExpansionForKey
加入聊天室 joinChatRoom joinChatRoom
退出聊天室 quitChatRoom quitChatRoom
查询聊天室信息 getChatRoomInfo getChatRoomInfo
聊天室设置属性 setChatroomEntry setChatRoomEntry
聊天室批量设置属性 setChatRoomEntries setChatRoomEntries
聊天室强制设置属性 forceSetChatroomEntry forceSetChatRoomEntry
聊天室删除属性 removeChatroomEntry removeChatRoomEntry
聊天室强制删除属性 forceRemoveChatroomEntry forceRemoveChatRoomEntry
聊天室获取单个属性 getChatroomEntry getChatRoomEntry
聊天室获取所有属性 getAllChatroomEntries getAllChatRoomEntries
获取聊天室历史消息 getChatRoomHistoryMessages getChatroomHistoryMessages
文档反馈
意见反馈

您的改进建议

意见反馈

问题类型

联系我们

提交工单

技术支持|集成使用|产品方案


商务咨询

7 x 24 小时

为您解答方案与报价问题

131 6185 6839

文档反馈