未读数

未读数由服务端累加,客户端进入会话后可清零;支持 @ 提醒未读单独计数。

平台调用风格

进程模型:main(IMLib 客户端 + 本地 SQLite,单写者)/ preload(contextBridge 白名单)/ renderer(薄代理,不直连网络与数据库)。异步接口返回 Promise<RcResult<T>>。

接口一览​

操作语义传输返回
clearUnreadCount清空会话未读(等价 read 帧 + 本地清零)。WS 长连接null

本页 1 个操作,其中 1 个在本平台绑定中声明了方法签名。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
clearUnreadCountclearUnreadCountclearUnreadCountclearUnreadCountclearUnreadCountclearUnreadCount—func

方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。

clearUnreadCount​

清空会话未读(等价 read 帧 + 本地清零)。

clearUnreadCount(conversationType: ConversationType, targetId: string, options?: {untilTime?: number}): Promise<RcResult<null>>
WS 长连接幂等since 1.0.0
参数
参数类型说明
conversationTypeConversationType必填;会话类型枚举(ConversationType)
targetIdstring必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId
返回

null 无返回数据;成功与否通过错误码判断

示例
JavaScript
await client.clearUnreadCount(ConversationType.PRIVATE, 'user2'); /* code === 0 为成功 */

该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。

相关文档​