未读数
未读数由服务端累加,客户端进入会话后可清零;支持 @ 提醒未读单独计数。
C ABI 约定:im_client_* 返回 int(0 成功,非 0 为 IDL 错误码);char** out_json 由库分配、调用方用 im_string_free 释放;char* out + size_t cap 为调用方缓冲区(0 成功 / -1 参数非法 / -2 缓冲区不足)。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
clearUnreadCount | 清空会话未读(等价 read 帧 + 本地清零)。 | WS 长连接 | null |
本页 1 个操作,其中 0 个在本平台绑定中声明了方法签名,其余为 C ABI 未暴露(见对应小节)。
跨端方法名
| 操作 | Android | Web | Electron | macOS | Flutter | Native (C ABI) | iOS |
|---|---|---|---|---|---|---|---|
clearUnreadCount | clearUnreadCount | clearUnreadCount | clearUnreadCount | clearUnreadCount | clearUnreadCount | — | func |
方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。
本页操作均未在正式 C ABI(include/im_sdk.h)中暴露。C ABI 当前覆盖 18 个操作:init / connect / disconnect / getConnectionStatus / getCurrentUserId / sendTextMessage / sendMessage / recallMessage / sendReadReceipt / getConversationList / getHistoryMessages / getGroupMembers / joinChatroom / leaveChatroom / getChatroomInfo / uploadFile / addEventListener / removeEventListener。其余能力请使用其它平台绑定,或通过服务端 Open API 完成。
| 替代路径 | 说明 |
|---|---|
| 服务端 Open API | 会话模块接口:在服务端批量管理消息、会话、群组与用户 |
| Web / Electron / Flutter / Android 绑定 | 这些绑定覆盖全部 62 个语义 op;可通过服务端中转或由另一进程执行后回调 Native 侧 |
clearUnreadCount
清空会话未读(等价 read 帧 + 本地清零)。
本操作未在 native C ABI(include/im_sdk.h)暴露;如需该能力,请使用 Web / Electron / Flutter / Android 绑定,或通过服务端 Open API 完成。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 必填;会话类型枚举(ConversationType) |
targetId | string | 必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId |
null 无返回数据;成功与否通过错误码判断
该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南