ReadReceipt 类(HarmonyOS IMLib)

契约预留平台

HarmonyOS 当前为契约预留:本页的类、方法签名、枚举与示例全部来自冻结 IDL 与 sdk-bindings.json,SDK 尚未交付;实现后签名不会变化。

类继承图​

Object→ReadReceipt

继承关系:Object → ReadReceipt。该数据结构不包含行为方法,字段与 domain.json → schemas.ReadReceipt 一一对应。

类说明​

已读回执:会话、读者、已读消息列表、各消息已读人数与会话总人数。

项值
类型数据结构(值对象)
字段数9
IDL 定义domain.json → schemas.ReadReceipt
程序包@ni-paas-im/harmony
跨端一致性字段名与取值在 7 个平台绑定中一致;仅语言类型映射不同
平台状态契约预留

字段概要​

字段类型必填说明
conversationTypeConversationType是会话类型,见 ConversationType
targetIdstring是目标 ID(userId / groupId / chatroomId / system)
readerIdstring是已读用户 userId
messageIdsstring[]是已读消息 ID 列表
readCountsmap<string,uint32>否各消息已读人数:messageId → readCount
totalMembersuint32否会话总人数(用于计算已读比例)
timestampint64是消息时间(epoch ms)
readAtint64否见字段类型定义
unreadCountsmap<string,uint32>否见字段类型定义

详细字段说明​

ConversationType conversationType
必填

会话类型,见 ConversationType

string targetId
必填

目标 ID(userId / groupId / chatroomId / system)

string readerId
必填

已读用户 userId

string[] messageIds
必填

已读消息 ID 列表

map<string,uint32> readCounts
可选

各消息已读人数:messageId → readCount

uint32 totalMembers
可选

会话总人数(用于计算已读比例)

int64 timestamp
必填

消息时间(epoch ms)

int64 readAt
可选

见字段类型定义

map<string,uint32> unreadCounts
可选

见字段类型定义

相关链接​