macOS API Reference

口径说明

融云公开文档不覆盖 macOS 原生 SDK 与桌面交付链（dmg / 代码签名 / 公证 / 分发 / Gatekeeper）；本页为本项目按 Apple 与 Electron 官方实践补齐的接入文档。

本页是 macOS 分区的 API 总入口：IMLib 的 103 个语义操作与 IMKit 的 10 个组件全部由 IDL 生成。macOS 与 Electron 共用绑定（bindings.macos.inherits = electron），因此签名与 Electron 完全一致，不存在第二套漂移 API。

生成口径

方法名与签名来自 sdk-bindings.json 的继承解析结果；操作、参数、返回、错误码来自 sdk-imlib.json；组件语义来自 sdk-imkit.json。

本平台绑定状态：ga；包：@ni-paas-im/electron。

IMLib 操作索引​

能力域操作文档
建立连接init、connect、disconnect、getConnectionStatus建立连接
连接监听addEventListener、removeEventListener、getCurrentUserId连接监听
发送消息sendMessage、sendTextMessage、sendImageMessage、sendFileMessage、sendVoiceMessage、sendLocationMessage发送消息
历史消息getHistoryMessages历史消息
消息管理recallMessage、searchMessages消息管理
已读回执sendReadReceipt、getMessageReadCount、getMessageReadUsers已读回执
输入状态sendTypingStatus输入状态
会话列表getConversationList、getConversation会话列表
未读数clearUnreadCount未读数
草稿saveTextMessageDraft、getTextMessageDraft、clearTextMessageDraft草稿
置顶与免打扰setConversationToTop、setConversationNotificationLevel置顶与免打扰
用户资料getUserProfile、updateMyUserProfile用户资料
在线状态getOnlineStatus、getOnlineStatusBatch在线状态
好友列表getFriends、searchUsers、setFriendRemark、deleteFriend好友列表
好友请求sendFriendRequest、getFriendRequests、acceptFriendRequest、rejectFriendRequest好友请求
黑名单getBlacklist、addToBlacklist、removeFromBlacklist黑名单
创建群组createGroup、getGroupsInfo创建群组
群成员getGroupMembers、addGroupMembers、removeGroupMembers、quitGroup群成员
群管理updateGroupName、updateGroupNotice、transferGroupOwner、addGroupAdmin、removeGroupAdmin、muteGroupMember群管理
加入与退出createChatroom、joinChatroom、leaveChatroom加入与退出
聊天室信息getChatroomInfo、getChatroomMembers聊天室信息
系统通知getSystemMessages系统通知
文件上传uploadFile文件上传
消息进阶updateMessageExpansion、getMessageExpansion、removeMessageExpansion、addMessageReaction、removeMessageReaction、batchGetMessageReactionSummaries、getMessageReactions、getMessageReactionUsers、startStreamMessage、appendStreamMessage、completeStreamMessage、getStreamMessage、combineMessages消息进阶
会话标签与分组createConversationTag、updateConversationTag、deleteConversationTag、getConversationTags、addConversationsToTag、removeConversationsFromTag、getConversationsFromTagByPage、getTagsFromConversation、getUnreadCountByTag、setConversationToTopInTag会话标签与分组
会话删除与类型免打扰deleteConversation、getConversationTypeNotification、setConversationTypeNotification会话删除与类型免打扰
在线状态订阅与推送令牌subscribePresence、unsubscribePresence、getPresenceSubscriptions、registerPushToken、unregisterPushToken、getPushTokens在线状态订阅与推送令牌
超级群频道与用户组createSupergroupChannel、listSupergroupChannels、joinSupergroupChannel、leaveSupergroupChannel、bindUserGroupToChannel、createUserGroup、listUserGroups、getUserGroupsByUser超级群频道与用户组

完整的类 / 枚举 / 事件载荷：IMLib API 参考、类、枚举、SDK 公开面。

IMKit 组件契约索引（宿主渲染）​

组件职责PropsEvents文档
ConversationListView会话列表43会话列表
ChatView会话详情（消息流 + 输入区）812会话详情（消息流 + 输入区）
MessageBubble消息气泡（按内容类型渲染）98消息气泡（按内容类型渲染）
MessageInput输入区57输入区
Avatar头像40头像
UnreadBadge未读/提及角标30未读/提及角标
TimeSeparator时间分隔/格式化20时间分隔/格式化
MessageStatusIndicator发送状态30发送状态
Theme主题令牌20主题令牌
IMKitFacade组件门面/挂载入口12组件门面/挂载入口

SDK 不导出 UI 组件：以下为契约语义，宿主按 props / events / behaviors 自渲染。汇总：IMKit 组件 API；能力矩阵：IMKit 功能列表。

错误码与事件​