IMKit 5.X 版本升级
IMKit 5.X 版本升级:从旧版本 IMLib/IMKit 升级到当前 5.x:先对齐契约与依赖,再按变更清单回归核心链路。
适用场景
- 2.x/4.x 工程升级到 5.x
- 升级后编译/运行回归
前置条件
- 备份工程与本地数据
- 确认依赖版本可共存
- 准备回归用例(连接/消息/会话)
融云行为(对照)
融云文档中「IMKit 5.X 版本升级」提供完整的页面/流程说明(原文见 ios-imkit/upgrade/upgrade-imkit);其能力通常由 IMLib + 服务端或其他产品组件共同实现。
我们的实现与替代
按「升级与兼容」页的检查清单逐项替换;先在分支完成编译与核心链路回归。 本页「IMKit 5.X 版本升级」的替代路径:以 IMLib 已有能力组合实现,具体差异见「与融云对应页 / 差异」与功能列表。
差异与排期
- 当前 IMLib 契约未提供该主题的直接 op:当前文档只覆盖 5.x GA 的公开面;旧版本迁移脚本与兼容层不在本站承诺范围。
- 本站不提供占位/伪造接口;页面只描述可验证的替代路径与需要宿主补齐的部分。
- 如业务强依赖该能力,建议在服务端/宿主侧实现,并在「功能列表」页登记差异。
迁移建议
- 先按现有 IMLib 能力把核心链路(连接/消息/会话)跑通。
- 把该主题拆为「服务端接口 + 客户端展示」两部分,分别排期。
- 实现后补充本页的 API、示例与验收用例,并更新功能列表。
不伪造已实现
本页是能力边界说明,不代表 SDK 已提供同名接口;接口面以 API 参考与冻结契约为准。
对应 IMKit 组件
该主题由 ConversationListView 组件承载(会话列表)。
| 契约项 | 内容 |
|---|---|
| Props | conversations activeTargetId? theme? options? |
| Events | select longpress refresh |
| Behaviors | 排序:置顶优先,其余按 updatedAt 倒序;未读角标:unreadCount>0 显示;>99 显示 99+;mention count 独立角标;免打扰(notificationLevel=2)显示静音图标且不显示红点(保留数字可选);空闲(无会话)显示空态;加载中显示骨架;点击会话触发 select,宿主负责跳转 ChatView |
Swift / Objective-C 接入
// ConversationListView:IMKit 5.X 版本升级
let upgradeimkitView = ConversationListView(frame: .zero)
upgradeimkitView.frame = container.bounds
container.addSubview(upgradeimkitView)
// 数据/回调见组件 API:/docs/ios-imkit/components/conversation-list-view该组件的 Objective-C 入口没有可解析的初始化选择器(绑定声明是说明文本,不是可编译代码),因此不展示 Objective-C 代码块;按下面接入表使用;组件页提供 Objective-C 接入表(helper 组件为 Swift 专用,无独立 ObjC 示例)。
| 项 | 值 |
|---|---|
| Objective-C 类 | 未导出独立类(使用协议/渲染器) |
| 初始化选择器 | init |
| 接入方式 | 按 ConversationListView 组件页 的 Objective-C 接入表与渲染器约定接入 |
组件边界
IMKit 只依赖 IMLib 公开协议与模型;不得在组件层直连传输/存储实现。宿主负责页面导航与权限。
与融云对应页 / 差异
| 项 | 内容 |
|---|---|
| 融云页面 | ios-imkit/upgrade/upgrade-imkit(IMKit 5.X 版本升级) |
| 融云接口状态 | 边界页(非接口页) |
| 我方对应 | 无直接 op(见差异说明) |
| 差异说明 | 5.X 升级说明 |
能力缺口(如实标注)
融云该页描述的能力未完全在 IMLib 102 op / 16 事件中覆盖:5.X 升级说明。本页不提供伪造接口。
相关错误码
| 错误码 | 名称 | 含义 | 处理 |
|---|---|---|---|
1001 | INVALID_PARAMETER | 参数错误 | 修正参数/权限后重试 |
1002 | INVALID_TOKEN | Token 无效或已过期 | 修正参数/权限后重试 |
1007 | MESSAGE_TOO_LARGE | 消息体过大(上限 5KB) | 修正参数/权限后重试 |
1009 | GROUP_MUTED | 你已被禁言 | 修正参数/权限后重试 |
1010 | SENSITIVE_WORD | 内容包含敏感词 | 修正参数/权限后重试 |
3001 | SDK_NOT_CONNECTED | 长连接未就绪 | 可重试(退避) |
3002 | SDK_TIMEOUT | 请求超时 | 可重试(退避) |
3003 | SDK_NETWORK_ERROR | 网络错误 | 可重试(退避) |
接入检查
- 确认已导入
ImpIaaSIMKit并完成 IMLib 初始化/连接。 - 组件挂载到宿主 UIView 后,按契约注入数据(props/数据源)并注册事件。
- 自定义 Cell/菜单时保持消息模型为只读,避免直接修改 SDK 内部状态。