SDK 公开面与文档覆盖

本页回答一个具体问题：这个平台导出的每个公开方法、事件、枚举与数据类型，在文档中心的哪一页被说明？页面由 SDK 制品公开面（api-surface 快照）与 IDL 绑定声明生成，逐项给出签名与文档位置；差异（多余/缺失的方法）如实标注，不做静默补齐。

口径

契约（IDL 语义操作）是语义权威：方法名、参数、返回、错误码、示例都以功能页为准。

制品快照用于确认该平台是否真的导出了该方法；快照与实现不一致时，页面标注差异而不是猜测。

本页只做索引与核对，不重复功能页的参数表与示例。

来源与口径

项	内容
制品公开面	已读取该平台的 api-surface 快照（104 个公开方法）
契约语义	IDL 1.0.0 的 103 个语义操作 + 16 个事件
绑定签名	来自 IDL 绑定声明的方法签名（各平台语言风格）
口径说明	制品公开面快照包含 103 个公开方法（102 个 IDL 语义操作 + isChatroomJoined）。

覆盖摘要

类别	数量	文档承载位置
IDL 语义操作	103	功能页（每操作：说明 + 参数表 + 返回值 + 错误码 + 示例）
绑定便捷方法	1	本页「绑定便捷方法」小节
事件	16	本页事件表 + 连接监听
枚举 / 常量	6	API 参考「枚举」各页
数据类型	58	API 参考「类」各页 + 方法参数/返回值表

公开方法索引

下表逐项列出本平台导出的公开方法（IDL 语义操作在前，绑定便捷方法在后），并给出承载页面。功能页内的每个操作都有独立的参数表、返回值、错误码与可运行示例。

方法	本平台签名 / 形态	文档位置
`init`	`constructor(options) / init(options)`	建立连接
`connect`	`connect(token)`	建立连接
`disconnect`	`disconnect()`	建立连接
`getConnectionStatus`	`getConnectionStatus()`	建立连接
`getCurrentUserId`	`getCurrentUserId()`	连接监听
`addEventListener`	`addEventListener(event, handler)`	连接监听
`removeEventListener`	`removeEventListener(event, handler)`	连接监听
`sendMessage`	`sendMessage(conversationType, targetId, content, options?)`	发送消息
`sendTextMessage`	`sendTextMessage(conversationType, targetId, text, options?)`	发送消息
`sendImageMessage`	`sendImageMessage(conversationType, targetId, content, options?)`	发送消息
`sendFileMessage`	`sendFileMessage(conversationType, targetId, content, options?)`	发送消息
`sendVoiceMessage`	`sendVoiceMessage(conversationType, targetId, content, options?)`	发送消息
`sendLocationMessage`	`sendLocationMessage(conversationType, targetId, content, options?)`	发送消息
`sendTypingStatus`	`sendTypingStatus(conversationType, targetId, typing)`	输入状态
`recallMessage`	`recallMessage(messageId)`	消息管理
`sendReadReceipt`	`sendReadReceipt(conversationType, targetId, messageIds)`	已读回执
`getMessageReadCount`	`getMessageReadCount(messageId)`	已读回执
`getMessageReadUsers`	`getMessageReadUsers(messageId, options?)`	已读回执
`getMessageReadDetail`	`getMessageReadDetail(messageId, options?)`	API 参考索引
`searchMessages`	`searchMessages({keyword, limit?})`	消息管理
`getConversationList`	`getConversationList()`	会话列表
`getConversation`	`getConversation(conversationType, targetId)`	会话列表
`getHistoryMessages`	`getHistoryMessages(conversationType, targetId, options?)`	历史消息
`clearUnreadCount`	`clearUnreadCount(conversationType, targetId)`	未读数
`setConversationToTop`	`setConversationToTop(conversationType, targetId, isTop)`	置顶与免打扰
`saveTextMessageDraft`	`saveTextMessageDraft(conversationType, targetId, draft)`	草稿
`getTextMessageDraft`	`getTextMessageDraft(conversationType, targetId)`	草稿
`clearTextMessageDraft`	`clearTextMessageDraft(conversationType, targetId)`	草稿
`setConversationNotificationLevel`	`setConversationNotificationLevel(conversationType, targetId, level)`	置顶与免打扰
`getUserProfile`	`getUserProfile(userId)`	用户资料
`updateMyUserProfile`	`updateMyUserProfile({name?, avatarUrl?})`	用户资料
`getOnlineStatus`	`getOnlineStatus(userId)`	在线状态
`getOnlineStatusBatch`	`getOnlineStatusBatch(userIds)`	在线状态
`searchUsers`	`searchUsers(keyword, options?)`	好友列表
`sendFriendRequest`	`sendFriendRequest(toUserId, message?)`	好友请求
`getFriendRequests`	`getFriendRequests(options?)`	好友请求
`acceptFriendRequest`	`acceptFriendRequest(requestId)`	好友请求
`rejectFriendRequest`	`rejectFriendRequest(requestId)`	好友请求
`getFriends`	`getFriends()`	好友列表
`deleteFriend`	`deleteFriend(friendId)`	好友列表
`setFriendRemark`	`setFriendRemark(friendId, remark)`	好友列表
`getBlacklist`	`getBlacklist()`	黑名单
`addToBlacklist`	`addToBlacklist(userId)`	黑名单
`removeFromBlacklist`	`removeFromBlacklist(userId)`	黑名单
`createGroup`	`createGroup({groupId?, name, owner?, members?, groupType?})`	创建群组
`getGroupsInfo`	`getGroupsInfo(groupIds)`	创建群组
`getGroupMembers`	`getGroupMembers(groupId)`	群成员
`addGroupMembers`	`addGroupMembers(groupId, userIds)`	群成员
`removeGroupMembers`	`removeGroupMembers(groupId, userIds)`	群成员
`quitGroup`	`quitGroup(groupId)`	群成员
`updateGroupName`	`updateGroupName(groupId, name)`	群管理
`updateGroupNotice`	`updateGroupNotice(groupId, notice)`	群管理
`transferGroupOwner`	`transferGroupOwner(groupId, newOwner)`	群管理
`addGroupAdmin`	`addGroupAdmin(groupId, userId)`	群管理
`removeGroupAdmin`	`removeGroupAdmin(groupId, userId)`	群管理
`muteGroupMember`	`muteGroupMember(groupId, userId, mutedUntil)`	群管理
`createChatroom`	`createChatroom({chatroomId?, name, owner?})`	加入与退出
`joinChatroom`	`joinChatroom(chatroomId)`	加入与退出
`leaveChatroom`	`leaveChatroom(chatroomId)`	加入与退出
`getChatroomInfo`	`getChatroomInfo(chatroomId)`	聊天室信息
`getChatroomMembers`	`getChatroomMembers(chatroomId, options?)`	聊天室信息
`getSystemMessages`	`getSystemMessages(options?)`	系统通知
`uploadFile`	`uploadFile(data, name, mime?)`	文件上传
`updateMessageExpansion`	`updateMessageExpansion(messageId, expansion)`	消息进阶
`removeMessageExpansion`	`removeMessageExpansion(messageId, keys)`	消息进阶
`addMessageReaction`	`addMessageReaction(params)`	消息进阶
`removeMessageReaction`	`removeMessageReaction(params)`	消息进阶
`batchGetMessageReactionSummaries`	`batchGetMessageReactionSummaries(params)`	消息进阶
`getMessageReactions`	`getMessageReactions(params)`	消息进阶
`getMessageReactionUsers`	`getMessageReactionUsers(params)`	消息进阶
`createConversationTag`	`createConversationTag(tagName, options)`	会话标签与分组
`updateConversationTag`	`updateConversationTag(tagId, tagName)`	会话标签与分组
`deleteConversationTag`	`deleteConversationTag(tagId)`	会话标签与分组
`getConversationTags`	`getConversationTags()`	会话标签与分组
`addConversationsToTag`	`addConversationsToTag(tagId, conversations)`	会话标签与分组
`removeConversationsFromTag`	`removeConversationsFromTag(tagId, conversations)`	会话标签与分组
`getConversationsFromTagByPage`	`getConversationsFromTagByPage(tagId, options)`	会话标签与分组
`getTagsFromConversation`	`getTagsFromConversation(conversationType, targetId)`	会话标签与分组
`getUnreadCountByTag`	`getUnreadCountByTag(tagId)`	会话标签与分组
`setConversationToTopInTag`	`setConversationToTopInTag(tagId, conversationType, targetId, top)`	会话标签与分组
`deleteConversation`	`deleteConversation(conversationType, targetId)`	会话删除与类型免打扰
`getConversationTypeNotification`	`getConversationTypeNotification(conversationType)`	会话删除与类型免打扰
`setConversationTypeNotification`	`setConversationTypeNotification(conversationType, level)`	会话删除与类型免打扰
`startStreamMessage`	`startStreamMessage(params)`	消息进阶
`appendStreamMessage`	`appendStreamMessage(streamId, delta, options?)`	消息进阶
`completeStreamMessage`	`completeStreamMessage(streamId)`	消息进阶
`getStreamMessage`	`getStreamMessage(streamId)`	消息进阶
`getMessageExpansion`	`getMessageExpansion(messageId: string): Promise<RcResult<MessageExpansion>>`	消息进阶
`combineMessages`	`combineMessages(messages: Message[], options?: CombineMessagesOptions): Promise<RcResult<CombineContent>>`	消息进阶
`subscribePresence`	`subscribePresence(userIds: string[]): Promise<RcResult<{subscribed: string[]}>>`	在线状态订阅与推送令牌
`unsubscribePresence`	`unsubscribePresence(userIds: string[]): Promise<RcResult<{subscribed: string[]}>>`	在线状态订阅与推送令牌
`getPresenceSubscriptions`	`getPresenceSubscriptions(): Promise<RcResult<{userId: string, subscribed: string[]}>>`	在线状态订阅与推送令牌
`registerPushToken`	`registerPushToken(options: RegisterPushTokenOptions): Promise<RcResult<PushToken>>`	在线状态订阅与推送令牌
`unregisterPushToken`	`unregisterPushToken(tokenId: string): Promise<RcResult<UnregisterPushTokenResult>>`	在线状态订阅与推送令牌
`getPushTokens`	`getPushTokens(): Promise<RcResult<PushTokenListResult>>`	在线状态订阅与推送令牌
`createSupergroupChannel`	`createSupergroupChannel(params: CreateSupergroupChannelParams): Promise<RcResult<SupergroupChannel>>`	超级群频道与用户组
`listSupergroupChannels`	`listSupergroupChannels(groupId: string): Promise<RcResult<SupergroupChannelListResult>>`	超级群频道与用户组
`joinSupergroupChannel`	`joinSupergroupChannel(channelId: string, options?: SupergroupChannelOptions): Promise<RcResult<JoinSupergroupChannelResult>>`	超级群频道与用户组
`leaveSupergroupChannel`	`leaveSupergroupChannel(channelId: string, options?: SupergroupChannelOptions): Promise<RcResult<LeaveSupergroupChannelResult>>`	超级群频道与用户组
`bindUserGroupToChannel`	`bindUserGroupToChannel(channelId: string, userGroupId: string, options?: SupergroupChannelOptions): Promise<RcResult<BindUserGroupToChannelResult>>`	超级群频道与用户组
`createUserGroup`	`createUserGroup(params: CreateUserGroupParams): Promise<RcResult<UserGroup>>`	超级群频道与用户组
`listUserGroups`	`listUserGroups(groupId: string): Promise<RcResult<UserGroupListResult>>`	超级群频道与用户组
`getUserGroupsByUser`	`getUserGroupsByUser(userId: string, options?: SupergroupChannelOptions): Promise<RcResult<UserGroupListResult>>`	超级群频道与用户组
`isChatroomJoined`	绑定便捷方法	本地判断当前用户是否已加入指定聊天室（内存态，不发起网络请求）。

事件索引

事件名在所有 GA 平台一致（Web 为小写下划线常量值，原生平台为枚举成员）。事件订阅方式见连接监听页；载荷字段来自 IDL 事件定义。

事件	载荷	本平台导出	文档位置
`CONNECTING`	`{attempt:int}`	是	API 参考 · 事件载荷
`CONNECTED`	`{userId:string, sessionId?:string}`	是	API 参考 · 事件载荷
`DISCONNECT`	`{code:int, reason:string}`	是	API 参考 · 事件载荷
`SUSPEND`	`{code:int, reason:string}`	是	API 参考 · 事件载荷
`MESSAGES`	`{messages:Message[]}`	是	API 参考 · 事件载荷
`CONVERSATION`	`{conversation:Conversation}`	是	API 参考 · 事件载荷
`MESSAGE_RECALLED`	`{message:Message}`	是	API 参考 · 事件载荷
`READ_RECEIPT`	`ReadReceipt`	是	API 参考 · 事件载荷
`TYPING`	`{conversationType:ConversationType,targetId:string,userId:string,typing:bool,timestamp:int64}`	是	API 参考 · 事件载荷
`MESSAGE_REACTION_CHANGED`	`{messageId:string,conversationType:ConversationType,targetId:string,reactionId:string,operation:added\|removed\|cleared,userId:string,reactionTime:int64,totalCount:uint32,users:string[]?}`	是	API 参考 · 事件载荷
`MESSAGE_EXPANSION_CHANGED`	`{messageId:string,conversationType:ConversationType,targetId:string,updated:Record<string,string>?,removed:string[]?,timestamp:int64}`	是	API 参考 · 事件载荷
`STREAM_MESSAGE_CHANGED`	`{streamId:string,messageId:string,conversationType:ConversationType,targetId:string,senderId:string,delta:string,seq:uint32,text:string,status:streaming\|ended,complete:bool,timestamp:int64}`	否	API 参考 · 事件载荷
`PRESENCE_CHANGED`	`{userId:string,online:bool,lastSeenAt:int64,timestamp:int64,reason:connect\|disconnect\|kick\|deactivate}`	是	API 参考 · 事件载荷
`FRIEND_EVENT`	`{kind:FriendEventKind,request?:FriendRequest,fromUserId?:string,toUserId?:string,timestamp:int64}`	是	API 参考 · 事件载荷
`CHATROOM_EVENT`	`{chatroomId:string,kind:ChatroomEventKind,userId?:string,onlineCount?:uint32,chatroom?:Chatroom,timestamp:int64}`	是	API 参考 · 事件载荷
`KICKED`	`{code:int,reason:string}`	是	API 参考 · 事件载荷

枚举与常量索引

枚举取值在 API 参考的「枚举」页逐项列出（名称、取值、语义），错误码另有状态码页。

常量 / 枚举	取值数	文档位置
`Events`	17	枚举 · event-type
`RCConnectionStatus`	4	枚举 · connection-status
`ConversationType`	5	枚举 · conversation-type
`MessageDirection`	2	枚举 · direction
`ErrorCode`	47	枚举 · error-code
`SYSTEM_TARGET_ID`	—	状态码与错误处理

数据类型索引

公开数据类型分两类：有独立页面的核心结构（消息、会话、群组、内容联合体等），以及只作为参数/返回结构出现的选项与结果对象（字段在对应方法的参数表与返回值中说明）。

类型	文档位置
`Chatroom`	数据结构 · Chatroom
`ChatroomMember`	数据结构 · ChatroomMember
`ConnectionStatus`	枚举 · ConnectionStatus
`Conversation`	数据结构 · Conversation
`ConversationType`	枚举 · ConversationType
`Friend`	数据结构 · Friend
`FriendRequest`	数据结构 · FriendRequest
`Group`	数据结构 · Group
`GroupMember`	数据结构 · GroupMember
`GroupType`	枚举 · GroupType
`Message`	数据结构 · Message
`NotificationLevel`	枚举 · NotificationLevel
`UserProfile`	数据结构 · UserProfile

随方法说明的类型

ChannelType、CombineContent、Config、Content、ConversationRef、ConversationTag、ConversationTagConversation、Conversations、Count、Counts、CurrentUserReacted、GroupId、Groups、IMClient、Id、Ids、Inactive、Indexed、Info、JoinPolicy、Joined、MaxChars、Member、Members、MentionedInfo、MessageReadDetailItem、More、Ms、MsgId、Names、Policy、PushToken、Quote、ReactionSummary、Seq、StreamMessage、SupergroupChannel、Time、Token、Total、Type、Until、Url、UserGroup、Version

如何反馈差异

方法语义与签名：以功能列表与各功能页为准；
错误码与重试：见状态码；
若发现“制品导出但文档未说明”或“文档说明但制品未导出”，请提交到文档反馈渠道，会按版本更新日志同步。

SDK 公开面与文档覆盖

来源与口径​

覆盖摘要​

公开方法索引​

事件索引​

枚举与常量索引​

数据类型索引​

随方法说明的类型​

如何反馈差异​