跳到主要内容

SDK 迁移

停止维护旧版 Flutter 5.X SDK 的说明

提示

仅适用于已集成 Flutter 5.X 旧版 SDK (rongcloud_im_plugin) 的客户。

Flutter 5.X 旧版 SDK (rongcloud_im_plugin) 已不再进行维护,旧版开发文档不再公开提供,建议已集成旧版 SDK 的客户迁移到新版本 SDK。新版本 SDK 整体进行了优化重构。所有新功能都将在新版 SDK 中进行添加。

新集成的客户,请直接使用新版 SDK(rongcloud_im_wrapper_plugin)。详见快速上手

迁移方法

Flutter IMLib 5x 旧版 SDK 与新版 SDK 不兼容,为帮助已集成 Flutter 5.X 旧版 SDK 的客户迁移到新版 SDK(rongcloud_im_wrapper_plugin),我们整理了新旧版本 SDK API 使用差异。请开发者根据自身 API 使用情况与 API 差异,合理安排开发周期。详细内容可参考以下文档:

新旧 API 对照速查表

注意事项

  1. 新版本 SDK 与旧版本(指低于 Flutter 5.2.4 版本)定义的自定义消息机制互相不兼容,无法正确解析。
  2. 新版本 SDK 更换了仓库地址,旧的仓库不在进行维护。

其他区别

  1. 新版本 SDK 的接口需要使用 RCIMIWEngine 对象进行调用,且有完整的生命周期,所以构建对象需要开发者进行保存,以便后续接口调用。旧版本 SDK 的接口直接通过调用 RongIMClient 提供的静态方法。
  2. 新版本 SDK 接口大部分的结果处理,都不在当前接口进行体现,需要开发者实现对应的方法回调进行处理,且如果接口调用多次,SDK 都会触发同一个回调,但回调中会返回接口调用参数,需要开发者根据参数来进行区分。旧版本部分接口回调可在接口内直接获取。
  3. 新版本 SDK 如果多处设置同一个监听,只有最后一次设置才会生效。为避免其余监听失效而引起问题,建议全局只设置一次。

支持 callback 回调参数

Flutter SDK 从 5.3.1 版本开始,部分接口新增 callback 参数。在传入 callback 参数后,仅通过 callback 参数触发回调,不再触发其他回调。