图片和 GIF 消息

图片和 GIF 消息:IMKit 以组件 + 数据源/回调的方式提供 UI 能力;本页聚焦该功能在组件层的接入点与配置。

适用场景​

  • 需要在现成会话页/会话列表上扩展功能
  • 需要确认功能对应的组件与 props/events

前置条件​

  • 已导入 ImpIaaSIMKit
  • 已完成 IMLib 初始化与连接
  • 宿主容器可挂载 UIView

相关 API(本项目可用 op)​

融云对应能力未完全覆盖;以下为本项目可用的相关 op,示例按真实签名生成。

能力与 API​

以下操作来自冻结的 sdk-imlib.json;签名与参数逐字取自 sdk-bindings.json → bindings.ios.imlib.methodMap。

操作Swift 签名返回参数
sendImageMessagefunc sendImageMessage(conversationType: IMPConversationType, targetId: String, content: IMPImageContent, options: IMPSendOptions?) async -> RcResult<IMPMessage>MessageconversationType:ConversationType, targetId:string, content:{url:string,width?:uint32,height?:uint32,size?:uint64}, options?:{clientMsgId?:string, channelId?:string}

完整字段与错误码见 API 参考;示例可直接复制到 Swift/Objective-C 工程。

Swift / Objective-C 示例​

let res = await client.sendImageMessage(conversationType: .privateChat, targetId: "user2", content: IMPImageContent(url: "https://cdn.example.com/a.png"), options: nil)
if res.code != 0 { print("IM 调用失败:\(res.msg ?? "")") }
[client sendImageMessageWithConversationType:1 /* 单聊 */ targetId:@"user2" content:@{ @"url": @"https://cdn.example.com/a.png", @"width": @0, @"height": @0, @"size": @0 } options:nil completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败:%ld %@", (long)result.code, result.msg); }
}];
错误处理

IMLib 不 throw:检查 res.code。常见:1002 Token 无效、1001 参数错误、3001 未连接(可重试)、3002 超时。完整码表见 状态码。

对应 IMKit 组件​

该主题由 MessageBubble 组件承载(消息气泡(按内容类型渲染))。

契约项内容
Propsmessage isMine showStatus? showReadCount? reactions? expansion? onReactionClick? onReactionLongPress?
Eventslongpress reaction_click reaction_longpress tapImage tapFile tapVoice tapLocation stream_chunk
Behaviors回应 chip 按 reactionTime 升序排列(同值保持输入顺序);hasCurrentUserReacted=true 的 chip 高亮为 active 态(主题色描边 + aria-pressed=true);chip 计数 >99 显示 99+;计数<=0 或 reactionId 空的 chip 不渲染;消息扩展徽标按 key:value 渲染,最多 3 对,超出部分显示 +N(N=未展示对数);气泡长按(pointerdown >=500ms)或右键触发 reaction_longpress(message) / onReactionLongPress,由宿主打开回应选择器;streaming=true 时 content.type=stream 渲染增量文本 + 生成中光标;complete 后收敛为普通文本气泡(streaming:false 可关闭)

Swift / Objective-C 接入​

// MessageBubble:图片和 GIF 消息
let imagegifmessageView = MessageBubbleView(message: message, isMine: true)
imagegifmessageView.frame = container.bounds
container.addSubview(imagegifmessageView)
// 数据/回调见组件 API:/docs/ios-imkit/components/message-bubble

该组件的 Objective-C 入口没有可解析的初始化选择器(绑定声明是说明文本,不是可编译代码),因此不展示 Objective-C 代码块;按下面接入表使用;组件页提供 Objective-C 接入表(helper 组件为 Swift 专用,无独立 ObjC 示例)。

项值
Objective-C 类未导出独立类(使用协议/渲染器)
初始化选择器—
接入方式按 MessageBubble 组件页 的 Objective-C 接入表与渲染器约定接入
组件边界

IMKit 只依赖 IMLib 公开协议与模型;不得在组件层直连传输/存储实现。宿主负责页面导航与权限。

能力与 API​

以下操作来自冻结的 sdk-imlib.json;签名与参数逐字取自 sdk-bindings.json → bindings.ios.imlib.methodMap。

操作Swift 签名返回参数
sendImageMessagefunc sendImageMessage(conversationType: IMPConversationType, targetId: String, content: IMPImageContent, options: IMPSendOptions?) async -> RcResult<IMPMessage>MessageconversationType:ConversationType, targetId:string, content:{url:string,width?:uint32,height?:uint32,size?:uint64}, options?:{clientMsgId?:string, channelId?:string}

完整字段与错误码见 API 参考;示例可直接复制到 Swift/Objective-C 工程。

Swift / Objective-C 示例​

let res = await client.sendImageMessage(conversationType: .privateChat, targetId: "user2", content: IMPImageContent(url: "https://cdn.example.com/a.png"), options: nil)
if res.code != 0 { print("IM 调用失败:\(res.msg ?? "")") }
[client sendImageMessageWithConversationType:1 /* 单聊 */ targetId:@"user2" content:@{ @"url": @"https://cdn.example.com/a.png", @"width": @0, @"height": @0, @"size": @0 } options:nil completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败:%ld %@", (long)result.code, result.msg); }
}];
错误处理

IMLib 不 throw:检查 res.code。常见:1002 Token 无效、1001 参数错误、3001 未连接(可重试)、3002 超时。完整码表见 状态码。

与融云对应页 / 差异​

项内容
融云页面ios-imkit/features/image-gif-message(图片和 GIF 消息)
融云接口状态部分覆盖(主路径可用,子能力缺失)
我方对应sendImageMessage、MessageBubble image 渲染器
差异说明静态图渲染与大图预览可用;GIF 动图播放未实现

相关错误码​

错误码名称含义处理
1001INVALID_PARAMETER参数错误修正参数/权限后重试
1002INVALID_TOKENToken 无效或已过期修正参数/权限后重试
1007MESSAGE_TOO_LARGE消息体过大(上限 5KB)修正参数/权限后重试
1009GROUP_MUTED你已被禁言修正参数/权限后重试
1010SENSITIVE_WORD内容包含敏感词修正参数/权限后重试
3001SDK_NOT_CONNECTED长连接未就绪可重试(退避)
3002SDK_TIMEOUT请求超时可重试(退避)
3003SDK_NETWORK_ERROR网络错误可重试(退避)

接入检查​

  • 确认已导入 ImpIaaSIMKit 并完成 IMLib 初始化/连接。
  • 组件挂载到宿主 UIView 后,按契约注入数据(props/数据源)并注册事件。
  • 自定义 Cell/菜单时保持消息模型为只读,避免直接修改 SDK 内部状态。

相关页面​