索引（HarmonyOS IMLib）
本页是 HarmonyOS IMLib 的完整索引：238 个条目，包含类、方法、事件、枚举与枚举常量。按名称首字母（A–Z）分组，并附中文术语索引。
契约预留平台
HarmonyOS 当前为契约预留：本页的类、方法签名、枚举与示例全部来自冻结 IDL 与 sdk-bindings.json，SDK 尚未交付；实现后签名不会变化。
快速跳转：A · B · C · D · E · F · G · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · 中文
A–Z 索引
A
| 名称 | 类型 | 说明 |
|---|---|---|
| accepted | 枚举常量 | FriendEventKind：好友请求被接受 |
| ACCEPTED | 枚举常量 | FriendRequestStatus：已接受 |
| acceptFriendRequest | 方法 | 同意申请，双向建立好友关系 |
| addConversationsToTag | 方法 | 把会话加入标签（≤100/次，幂等） |
| addEventListener | 方法 | 注册事件监听 |
| addGroupAdmin | 方法 | 设置管理员（群主，幂等） |
| addGroupMembers | 方法 | 拉人入群（群主/管理员） |
| addMessageReaction | 方法 | 为指定消息添加回应（reactionId 由业务定义，1-16 字符） |
| addToBlacklist | 方法 | 加入黑名单（幂等） |
| ADMIN | 枚举常量 | GroupRole：管理员 |
| ALL | 枚举常量 | NotificationLevel：全部提醒（默认） |
| ALL | 枚举常量 | MentionType：@所有人 |
| APP_DISABLED | 枚举常量 | ErrorCode：应用已停用 |
| appendStreamMessage | 方法 | 追加一个流式增量（IDL rev17） |
B
| 名称 | 类型 | 说明 |
|---|---|---|
| batchGetMessageReactionSummaries | 方法 | 批量查询消息回应摘要（1-100 个 messageId） |
| bindUserGroupToChannel | 方法 | 把用户组绑定到频道（IDL rev21 C17） |
| BLOCKED | 枚举常量 | ErrorCode：已被对方拉黑或你已拉黑对方 |
| broadcast | 枚举常量 | SystemType：广播消息 |
C
| 名称 | 类型 | 说明 |
|---|---|---|
| CALLBACK_DELIVERY_FAILED | 枚举常量 | ErrorCode：回调投递失败 |
| CALLBACK_INVALID | 枚举常量 | ErrorCode：回调配置无效 |
| Chatroom | 数据结构 | 聊天室资料：在线态会话，不落离线历史，默认只广播在线成员 |
| CHATROOM | 枚举常量 | ConversationType：聊天室 |
| CHATROOM_CLOSED | 枚举常量 | ErrorCode：聊天室已销毁 |
| chatroom_destroyed | 枚举常量 | SystemType：聊天室销毁 |
| CHATROOM_EVENT | 事件 | 聊天室事件：成员加入/退出/被移出、成员变更、聊天室销毁 |
| CHATROOM_NOT_FOUND | 枚举常量 | ErrorCode：聊天室不存在 |
| ChatroomEventKind | 枚举 | 聊天室事件类型 |
| ChatroomMember | 数据结构 | 聊天室成员：userId、昵称、在线状态与加入时间 |
| clearTextMessageDraft | 方法 | 清除草稿 |
| clearUnreadCount | 方法 | 清空会话未读（等价 read 帧 + 本地清零） |
| combine | 枚举常量 | ContentType |
| combineMessages | 方法 | 本地构造合并转发内容（IDL rev19，transport=local，不做网络 IO）：把 Message[] 转换为 `{type:'co… |
| completeStreamMessage | 方法 | 结束流式消息（IDL rev17） |
| connect | 方法 | 使用用户 token 建立长连接：握手→hello→离线补发→sync_done |
| CONNECTED | 事件 | 连接建立成功：收到服务端 hello 之后触发，可开始发送请求 |
| CONNECTED | 枚举常量 | ConnectionStatus：已连接（收到 hello 之后） |
| CONNECTING | 事件 | 连接建立中：每次建连/重连尝试时触发，载荷含重试次数 attempt |
| CONNECTING | 枚举常量 | ConnectionStatus：正在建连 / 重连 |
| ConnectionStatus | 枚举 | 连接状态 |
| ContentType | 枚举 | 消息内容类型 |
| Conversation | 数据结构 | 会话聚合视图：未读数、@ 未读、置顶、草稿、提醒级别与最后一条消息 |
| CONVERSATION | 事件 | 会话变更：未读数、置顶、提醒级别、草稿或最后一条消息变化时触发 |
| CONVERSATION_NOT_FOUND | 枚举常量 | ErrorCode：会话不存在（标签内置顶等操作要求会话已在标签内） |
| ConversationType | 枚举 | 会话类型 |
| createChatroom | 方法 | 创建聊天室（客户端能力） |
| createConversationTag | 方法 | 创建会话标签（tagName ≤16） |
| createGroup | 方法 | 创建群（groupType 缺省 normal） |
| createSupergroupChannel | 方法 | 创建超级群频道（IDL rev21 C17） |
| createUserGroup | 方法 | 创建超级群用户组（IDL rev21 C17） |
| custom | 枚举常量 | ContentType：自定义消息（data 任意 JSON 透传） |
D
| 名称 | 类型 | 说明 |
|---|---|---|
| deleteConversation | 方法 | 删除会话记录（列表项/未读/草稿/置顶），历史消息保留 |
| deleteConversationTag | 方法 | 删除会话标签（同时清除标签内会话引用） |
| deleteFriend | 方法 | 双向删除好友 |
| DEPENDENCY_UNAVAILABLE | 枚举常量 | ErrorCode：依赖服务不可用 |
| destroyed | 枚举常量 | ChatroomEventKind：聊天室销毁 |
| Direction | 枚举 | 消息方向 |
| disconnect | 方法 | 主动断开 |
| DISCONNECT | 事件 | 连接断开：主动断开、鉴权失败或放弃重连时触发 |
| DISCONNECTED | 枚举常量 | ConnectionStatus：未连接（初始、主动断开、鉴权失败或放弃重连） |
E
| 名称 | 类型 | 说明 |
|---|---|---|
| ErrorCode | 枚举 | 错误码 |
| EventType | 枚举 | 事件类型 |
| EXPANSION_LIMIT_EXCEEDED | 枚举常量 | ErrorCode：消息扩展超出限制（单次 20 对 / 单条 300 对 / 键值长度） |
F
| 名称 | 类型 | 说明 |
|---|---|---|
| file | 枚举常量 | ContentType：文件消息 |
| FORBIDDEN | 枚举常量 | ErrorCode：无权限 |
| Friend | 数据结构 | 好友条目：userId、昵称、头像、备注、在线状态与黑名单标记 |
| friend_accepted | 枚举常量 | SystemType：好友请求被接受 |
| FRIEND_EVENT | 事件 | 好友事件：好友请求、接受、拒绝等事件，载荷含 FriendRequest |
| FriendEventKind | 枚举 | 好友事件类型 |
| FriendRequest | 数据结构 | 好友请求：请求 ID、发起/接收双方、附言与处理状态（pending / accepted / rejected） |
| FriendRequestStatus | 枚举 | 好友请求状态 |
G
| 名称 | 类型 | 说明 |
|---|---|---|
| getBlacklist | 方法 | 黑名单列表 |
| getChatroomInfo | 方法 | 聊天室信息（含在线数） |
| getChatroomMembers | 方法 | 聊天室在线成员列表 |
| getConnectionStatus | 方法 | 返回 ConnectionStatus 枚举值 |
| getConversation | 方法 | 单会话详情 |
| getConversationList | 方法 | 会话列表：置顶优先、按 updatedAt 倒序 |
| getConversationsFromTagByPage | 方法 | 分页获取标签内会话（含置顶/未读数/最后消息时间） |
| getConversationTags | 方法 | 获取全部会话标签（含会话数量） |
| getConversationTypeNotification | 方法 | 查询按会话类型默认免打扰级别（0 全部 / 1 仅 @ / 2 免打扰） |
| getCurrentUserId | 方法 | 当前登录 userId |
| getFriendRequests | 方法 | 好友申请列表（incoming/outgoing，pending/all） |
| getFriends | 方法 | 好友列表（含备注/在线/拉黑标记） |
| getGroupMembers | 方法 | 群成员列表（含角色/禁言） |
| getGroupsInfo | 方法 | 批量查询群信息（<=20） |
| getHistoryMessages | 方法 | 历史消息分页（beforeSeq 向前翻页） |
| getMessageExpansion | 方法 | 读取已发送消息的扩展 KV（IDL rev19） |
| getMessageReactions | 方法 | 分页查询指定消息的回应列表（count 1-50，默认 20） |
| getMessageReactionUsers | 方法 | 分页查询某个回应的参与用户（count 1-50，默认 20） |
| getMessageReadCount | 方法 | 查询消息已读人数 |
| getMessageReadDetail | 方法 | 查询单条消息的已读详情：已读/未读名单 + 具体读取时间（分页） |
| getMessageReadUsers | 方法 | 查询已读用户明细（分页） |
| getOnlineStatus | 方法 | 查询单个用户在线状态 |
| getOnlineStatusBatch | 方法 | 批量在线状态（<=100） |
| getPresenceSubscriptions | 方法 | 查询当前用户的在线状态订阅列表（IDL rev20） |
| getPushTokens | 方法 | 查询本人设备推送 token（IDL rev21 C23） |
| getStreamMessage | 方法 | 查询流式消息快照（IDL rev17） |
| getSystemMessages | 方法 | 系统通知历史（会话 conversationType=SYSTEM，targetId='system'） |
| getTagsFromConversation | 方法 | 查询某个会话所属的标签列表 |
| getTextMessageDraft | 方法 | 读取草稿 |
| getUnreadCountByTag | 方法 | 标签内未读汇总（消息总数 + 有未读的会话数） |
| getUserGroupsByUser | 方法 | 查询某用户所在的所有用户组（IDL rev21 C17） |
| getUserProfile | 方法 | 查询用户资料 |
| Group | 数据结构 | 群组资料：群名、群主、成员、管理员、禁言映射、公告与成员上限 |
| GROUP | 枚举常量 | ConversationType：群组（普通群） |
| group_dismissed | 枚举常量 | SystemType：群组解散 |
| group_member_changed | 枚举常量 | SystemType：群成员变更 |
| GROUP_MUTED | 枚举常量 | ErrorCode：你已被禁言 |
| GROUP_NOT_FOUND | 枚举常量 | ErrorCode：群组不存在 |
| group_notice_changed | 枚举常量 | SystemType：群公告变更 |
| GroupMember | 数据结构 | 群成员：userId、昵称、角色（群主/管理员/成员）、禁言截止时间与加入时间 |
| GroupRole | 枚举 | 群成员角色 |
| GroupType | 枚举 | 群组类型 |
I
| 名称 | 类型 | 说明 |
|---|---|---|
| image | 枚举常量 | ContentType：图片消息 |
| IMClient | 类 | IMLib 入口 |
| IMClientEvent | 监听器 | 事件监听接口 |
| init | 方法 | 初始化 SDK（构造客户端实例） |
| INTERNAL_ERROR | 枚举常量 | ErrorCode：服务端内部错误 |
| INVALID_PARAMETER | 枚举常量 | ErrorCode：参数错误 |
| INVALID_SIGNATURE | 枚举常量 | ErrorCode：签名错误 |
| INVALID_TOKEN | 枚举常量 | ErrorCode：Token 无效或已过期 |
J
| 名称 | 类型 | 说明 |
|---|---|---|
| joinChatroom | 方法 | 加入聊天室：发送 chatroom_join，收到 chatroom_joined |
| joined | 枚举常量 | ChatroomEventKind：成员加入 |
| joinSupergroupChannel | 方法 | 加入超级群频道（IDL rev21 C17） |
K
L
| 名称 | 类型 | 说明 |
|---|---|---|
| leaveChatroom | 方法 | 离开聊天室 |
| leaveSupergroupChannel | 方法 | 离开超级群频道（IDL rev21 C17） |
| left | 枚举常量 | ChatroomEventKind：成员退出 |
| listSupergroupChannels | 方法 | 超级群频道列表（IDL rev21 C17） |
| listUserGroups | 方法 | 超级群用户组列表（IDL rev21 C17） |
| location | 枚举常量 | ContentType：位置消息 |
M
| 名称 | 类型 | 说明 |
|---|---|---|
| MEMBER | 枚举常量 | GroupRole：普通成员 |
| member_changed | 枚举常量 | ChatroomEventKind：成员信息变更 |
| MEMBERSHIP_LIMIT | 枚举常量 | ErrorCode：成员数量超出上限 |
| MENTION | 枚举常量 | NotificationLevel：仅提醒 @ 提及 |
| MentionType | 枚举 | @ 提及类型 |
| Message | 数据结构 | 消息实体 |
| MESSAGE_ALREADY_RECALLED | 枚举常量 | ErrorCode：消息已撤回 |
| MESSAGE_EXPANSION_CHANGED | 事件 | — |
| MESSAGE_NOT_EXPANDABLE | 枚举常量 | ErrorCode：消息不可扩展（发送时未开启可扩展，或会话类型不支持） |
| MESSAGE_REACTION_CHANGED | 事件 | — |
| MESSAGE_RECALLED | 事件 | 消息被撤回：收到服务端撤回帧，载荷为被撤回的 Message |
| MESSAGE_REJECTED_BY_CALLBACK | 枚举常量 | ErrorCode：发送前同步回调拒绝该消息（应用服务器返回 action=block，或降… |
| MESSAGE_TOO_LARGE | 枚举常量 | ErrorCode：消息体过大（上限 5KB） |
| MessageContent | 数据结构 | 消息内容联合体：按 type 取不同字段，序列化后不超过 5KB |
| MESSAGES | 事件 | 收到消息：在线消息与离线补发消息都通过该事件下发，载荷为 Message 列表 |
| MUTED | 枚举常量 | NotificationLevel：免打扰（不展示红点与角标） |
| muteGroupMember | 方法 | 禁言/解禁（群主/管理员） |
N
| 名称 | 类型 | 说明 |
|---|---|---|
| NONCE_REPLAYED | 枚举常量 | ErrorCode：Nonce 重复 |
| NORMAL | 枚举常量 | GroupType：普通群（成员上限 3000） |
| NOT_CHATROOM_MEMBER | 枚举常量 | ErrorCode：未加入聊天室 |
| NOT_GROUP_MEMBER | 枚举常量 | ErrorCode：未加入群组 |
| NotificationLevel | 枚举 | 会话提醒级别 |
O
| 名称 | 类型 | 说明 |
|---|---|---|
| OWNER | 枚举常量 | GroupRole：群主 |
P
| 名称 | 类型 | 说明 |
|---|---|---|
| PENDING | 枚举常量 | FriendRequestStatus：待处理 |
| PRESENCE_CHANGED | 事件 | — |
| PRIVATE | 枚举常量 | ConversationType：单聊（1 对 1） |
Q
| 名称 | 类型 | 说明 |
|---|---|---|
| quitGroup | 方法 | 退出群 |
| QUOTA_EXCEEDED | 枚举常量 | ErrorCode：超出配额 |
R
| 名称 | 类型 | 说明 |
|---|---|---|
| RATE_LIMITED | 枚举常量 | ErrorCode：发送过于频繁 |
| REACTION_INVALID | 枚举常量 | ErrorCode：回应标识非法（1-16 字符） |
| REACTION_LIMIT_EXCEEDED | 枚举常量 | ErrorCode：单条消息回应种类超出上限（50） |
| REACTION_USER_LIMIT_EXCEEDED | 枚举常量 | ErrorCode：单个回应参与用户超出上限（100） |
| READ_RECEIPT | 事件 | 已读回执：收到对方已读上报，载荷为 ReadReceipt |
| ReadReceipt | 数据结构 | 已读回执：会话、读者、已读消息列表、各消息已读人数与会话总人数 |
| recall | 枚举常量 | ContentType：撤回占位消息（服务端生成，客户端只读） |
| RECALL_EXPIRED | 枚举常量 | ErrorCode：超过撤回时限 |
| recallMessage | 方法 | 撤回消息（仅发送者、撤回时限内） |
| RECEIVE | 枚举常量 | Direction：接收：其他人发来的消息 |
| registerPushToken | 方法 | 注册设备推送 token（IDL rev21 C23 收口） |
| rejected | 枚举常量 | FriendEventKind：好友请求被拒绝 |
| REJECTED | 枚举常量 | FriendRequestStatus：已拒绝 |
| rejectFriendRequest | 方法 | 拒绝申请 |
| removeConversationsFromTag | 方法 | 把会话移出标签（≤100/次，幂等） |
| removeEventListener | 方法 | 移除事件监听 |
| removeFromBlacklist | 方法 | 移出黑名单 |
| removeGroupAdmin | 方法 | 取消管理员（群主） |
| removeGroupMembers | 方法 | 移除成员（群主/管理员） |
| removeMessageExpansion | 方法 | 删除消息扩展 KV（按 key） |
| removeMessageReaction | 方法 | 移除自己对指定消息的回应 |
| request | 枚举常量 | FriendEventKind：收到好友请求 |
S
| 名称 | 类型 | 说明 |
|---|---|---|
| saveTextMessageDraft | 方法 | 保存草稿（空串=清除） |
| SDK_NETWORK_ERROR | 枚举常量 | ErrorCode：网络错误 |
| SDK_NOT_CONNECTED | 枚举常量 | ErrorCode：长连接未就绪 |
| SDK_TIMEOUT | 枚举常量 | ErrorCode：请求超时 |
| SDK_UNSUPPORTED | 枚举常量 | ErrorCode：当前平台不支持该能力 |
| searchMessages | 方法 | 在当前用户全部会话中搜索文本消息（倒序） |
| searchUsers | 方法 | 搜索用户（userId/name，大小写不敏感，排除自己） |
| SEND | 枚举常量 | Direction：发送：本人发出的消息 |
| sendFileMessage | 方法 | 发送文件消息 |
| sendFriendRequest | 方法 | 发起好友申请 |
| sendImageMessage | 方法 | 发送图片消息 |
| sendLocationMessage | 方法 | 发送位置消息 |
| sendMessage | 方法 | 发送任意类型消息 |
| sendReadReceipt | 方法 | 上报已读回执 |
| sendTextMessage | 方法 | 发送文本消息 |
| sendTypingStatus | 方法 | 发送正在输入状态 |
| sendVoiceMessage | 方法 | 发送语音消息 |
| SENSITIVE_WORD | 枚举常量 | ErrorCode：内容包含敏感词 |
| SERVICE_NOT_ACTIVATED | 枚举常量 | ErrorCode：服务未开通 |
| setConversationNotificationLevel | 方法 | 会话提醒级别：0 全部 / 1 仅提及 / 2 免打扰 |
| setConversationToTop | 方法 | 会话置顶/取消 |
| setConversationToTopInTag | 方法 | 标签内置顶/取消置顶会话（同步会话会话级置顶状态） |
| setConversationTypeNotification | 方法 | 设置按会话类型默认免打扰级别（0 全部 / 1 仅 @ / 2 免打扰） |
| setFriendRemark | 方法 | 设置好友备注（<=64 字，空串清除） |
| startStreamMessage | 方法 | 开始一条流式消息（IDL rev17） |
| STORAGE_ERROR | 枚举常量 | ErrorCode：存储错误 |
| STREAM_MESSAGE_CHANGED | 事件 | — |
| subscribePresence | 方法 | 订阅用户在线状态（IDL rev20） |
| SUPER | 枚举常量 | GroupType：超级群（成员上限 100000） |
| SUPER_GROUP | 枚举常量 | ConversationType：超级群（rev22 新增） |
| SUSPEND | 事件 | 连接挂起：异常断开后 SDK 进入指数退避重连，期间业务请求会失败 |
| SUSPEND | 枚举常量 | ConnectionStatus：连接中断，SDK 正在指数退避重连（异常断开） |
| system | 枚举常量 | ContentType：系统通知消息 |
| SYSTEM | 枚举常量 | ConversationType：系统通知会话（固定 targetId=system） |
| system_notification | 枚举常量 | SystemType：通用系统通知 |
| SystemType | 枚举 | 系统通知子类型 |
T
| 名称 | 类型 | 说明 |
|---|---|---|
| TAG_CONVERSATION_LIMIT_EXCEEDED | 枚举常量 | ErrorCode：标签内会话数超过上限（1000） |
| TAG_LIMIT_EXCEEDED | 枚举常量 | ErrorCode：单用户会话标签数超过上限（20） |
| TAG_NOT_FOUND | 枚举常量 | ErrorCode：标签不存在 |
| text | 枚举常量 | ContentType：文本消息 |
| TIMESTAMP_EXPIRED | 枚举常量 | ErrorCode：时间戳超出允许窗口 |
| transferGroupOwner | 方法 | 转让群主（新群主须为成员） |
| TYPING | 事件 | 输入状态：收到“正在输入”状态帧 |
U
| 名称 | 类型 | 说明 |
|---|---|---|
| unregisterPushToken | 方法 | 注销本人设备推送 token（IDL rev21 C23） |
| unsubscribePresence | 方法 | 取消订阅用户在线状态（IDL rev20） |
| updateConversationTag | 方法 | 重命名会话标签 |
| updateGroupName | 方法 | 修改群名（群主/管理员） |
| updateGroupNotice | 方法 | 设置群公告（群主/管理员，<=500 字，空串清除） |
| updateMessageExpansion | 方法 | 更新已发送消息的扩展 KV（合并语义） |
| updateMyUserProfile | 方法 | 修改本人资料（name/avatarUrl） |
| uploadFile | 方法 | 上传文件（<=20MB），返回可用于图片/文件/语音消息的 url |
| user_banned | 枚举常量 | SystemType：用户被封禁 |
| USER_BANNED | 枚举常量 | ErrorCode：账号已被封禁 |
| USER_NOT_FOUND | 枚举常量 | ErrorCode：用户不存在 |
| UserProfile | 数据结构 | 用户资料：userId、昵称与头像 URL |
| USERS | 枚举常量 | MentionType：@指定用户 |
V
| 名称 | 类型 | 说明 |
|---|---|---|
| voice | 枚举常量 | ContentType：语音消息 |
中文索引
中文术语
| 术语 | 说明 | 指向 |
|---|---|---|
| 客户端 | IMLib 入口类与会话生命周期 | 类 client |
| 连接 | 建连、断线重连与连接状态 | 类 client |
| 消息 | 消息实体与收发接口 | 类 message |
| 消息内容 | 文本/图片/文件/语音/位置/自定义内容 | 类 message-content |
| 会话 | 会话列表、未读、置顶、草稿与免打扰 | 类 conversation |
| 群组 | 群资料、成员与群管理 | 类 group |
| 群成员 | 群成员角色与禁言 | 类 group-member |
| 聊天室 | 在线态会话与成员 | 类 chatroom |
| 用户资料 | 昵称、头像与在线状态 | 类 user-profile |
| 好友 | 好友关系与黑名单 | 类 friend |
| 好友请求 | 好友申请全流程 | 类 friend-request |
| 已读回执 | 已读人数与读者列表 | 类 read-receipt |
| 事件监听 | 事件注册、载荷与移除 | 类 listener |
| 错误码 | 33 个统一错误码 | 枚举 error-code |
| 枚举 | 全部客户端枚举 | enums |
| 已过时 | 已过时 API 与过时策略 | deprecated |
| 索引 | 类、方法、枚举的 A–Z 索引 | index |
| 所有类 | 全部类的平铺列表 | all-classes |