Skip to content

原生平台 API 名称映射

本页用于跨端产品、测试和 SDK 二次封装。参数语义与返回模型见对应分类文档。 iOS 与 macOS 虽然复用 Swift 实现,但作为两个独立平台列出;安装、权限、生命周期 和制品验收分别查阅各自 QuickStart。

Android 列表中的方法名表示同一能力。新项目默认从 XHIMJavaClientCompletableFuture + Listener 调用;只有存量 Kotlin 项目才直接使用 XHIMClient 的 coroutine/Flow 入口。每个 独立 API 页会把两者分成“Android · Java”和“Android · Kotlin (兼容)”两个真实选项,不把 Kotlin Continuation 字节码当成 Java API。

1. 生命周期与事件

统一能力iOSmacOSAndroidWindowsHarmonyOS
一键连接XHIMClient.connectXHIMClient.connectXHIMJavaClient.connectDevelopment / connectWithCredentialProvider;Kotlin 兼容 XHIMClient.connectXHIMClient.ConnectAsyncXHIMClient.connect
手动创建XHIMClient(configuration:)XHIMClient(configuration:)XHIMClient(configuration)new XHIMClient(configuration)new XHIMClient(configuration)
启动startstartstartStartAsyncstart
登录loginloginloginLoginAsynclogin
续凭updateCredentialupdateCredentialupdateCredentialUpdateCredentialAsyncupdateCredential
退出logoutlogoutlogoutLogoutAsynclogout
状态statestatestateStatestate
网络恢复notifyNetworkAvailablenotifyNetworkAvailablenotifyNetworkAvailableNotifyNetworkAvailablenotifyNetworkAvailable
诊断diagnosticsdiagnosticsdiagnosticsGetDiagnosticsdiagnostics
设备策略deviceSessionPolicySnapshotdeviceSessionPolicySnapshotdeviceSessionPolicySnapshotDeviceSessionPolicySnapshotdeviceSessionPolicySnapshot
兼容性compatibilitySnapshotcompatibilitySnapshotcompatibilitySnapshotCompatibilitySnapshotcompatibilitySnapshot
SDK 构建元信息XHIMSDK.metadata()XHIMSDK.metadata()XHIMSDK.metadata()XHIMSDK.MetadatagetXHIMSDKMetadata()
读取本机前后台状态currentAppRuntimeStatecurrentAppRuntimeStatecurrentAppRuntimeStateAppRuntimeStatecurrentAppRuntimeState
报告本机前后台状态setAppRuntimeStatesetAppRuntimeStatesetAppRuntimeStateSetAppRuntimeStateAsyncsetAppRuntimeState
关闭shutdownshutdownshutdownShutdownAsync / DisposeAsyncshutdown / destroy
事件eventseventseventsEvents()onEvent
账号状态事件XHIMEvent.accountStateChangedXHIMEvent.accountStateChangedXHIMEvent.AccountStateChangedXHIMEvent.AccountStateChangedXHIMAccountStateChangedEvent
投影事件projectionEventsprojectionEventsevents 筛选ProjectionEvents()onEvent 筛选

2. 消息

统一能力iOSmacOSAndroidWindowsHarmonyOS
文字sendTextsendTextsendTextSendTextAsyncsendText
标准/自定义sendMessagesendMessagesendMessageSendMessageAsyncsendMessage
编辑editTexteditTexteditTextEditTextAsynceditText
撤回recallrecallrecallRecallAsyncrecall
重试retryMessageretryMessageretryMessageRetryMessageAsyncretryMessage
取消待发消息cancelMessagecancelMessagecancelMessageCancelMessageAsynccancelMessage
Markdown 工厂XHIMStandardMessageFactory.markdownXHIMStandardMessageFactory.markdownXHIMStandardMessageFactory.markdownXHIMStandardMessageFactory.MarkdownXHIMStandardMessageFactory.markdown
Markdown 解码XHIMMarkdownContent.decodeXHIMMarkdownContent.decodeXHIMMarkdownContent.decodeXHIMMarkdownContent.DecodeXHIMMarkdownContent.decodeMessage
单条查询messagemessagemessageGetMessageAsyncmessage
本地消息分页messagesmessagesmessagesListMessagesAsyncmessages
按服务端 ID 批量查本地消息messages(conversationID:serverMessageIDs:)messages(conversationID:serverMessageIDs:)messages(conversationId, serverMessageIds)GetMessagesByServerIdsAsyncmessagesByServerIds
服务端历史getMessageHistorygetMessageHistorygetMessageHistoryGetMessageHistoryAsyncgetMessageHistory
搜索searchMessagessearchMessagessearchMessagesSearchMessagesAsyncsearchMessages
仅自己删除deleteMessageForSelfdeleteMessageForSelfdeleteMessageForSelfDeleteMessageForSelfAsyncdeleteMessageForSelf

3. 会话与已读

统一能力iOSmacOSAndroidWindowsHarmonyOS
会话分页conversationsconversationsconversationsListConversationsAsyncconversations
会话搜索searchConversationssearchConversationssearchConversationsSearchConversationsAsyncsearchConversations
单聊会话directConversationdirectConversationdirectConversationGetOrCreateDirectConversationAsyncdirectConversation
清空clearConversationclearConversationclearConversationClearConversationAsyncclearConversation
隐藏hideConversationhideConversationhideConversationHideConversationAsynchideConversation
单会话已读markConversationReadmarkConversationReadmarkConversationReadMarkConversationReadAsyncmarkConversationRead
全部已读markAllConversationsReadmarkAllConversationsReadmarkAllConversationsReadMarkAllConversationsReadAsyncmarkAllConversationsRead
隐藏全部会话hideAllConversationshideAllConversationshideAllConversationsHideAllConversationsAsynchideAllConversations
总未读totalUnreadCounttotalUnreadCounttotalUnreadCountGetTotalUnreadCountAsynctotalUnreadCount
成员已读conversationPeerReadsconversationPeerReadsconversationPeerReadsListConversationPeerReadsAsyncconversationPeerReads
批量群消息已读markGroupMessagesReadmarkGroupMessagesReadmarkGroupMessagesReadMarkGroupMessagesReadAsyncmarkGroupMessagesRead
逐群消息已读成员groupMessageReadersgroupMessageReadersgroupMessageReadersGetGroupMessageReadersAsyncgroupMessageReaders
按群成员治理历史消息moderateGroupMemberMessagesmoderateGroupMemberMessagesmoderateGroupMemberMessagesModerateGroupMemberMessagesAsyncmoderateGroupMemberMessages
置顶/免打扰(旧 Core 兼容基础入口)setConversationPreferencesetConversationPreferencesetConversationPreferenceSetConversationPreferenceAsyncsetConversationPreference
置顶/免打扰 + 账号私有会话扩展setConversationPreference(..., applicationExtensionJSON:)同 iOSsetConversationPreference(..., applicationExtensionJson)SetConversationPreferenceWithApplicationExtensionAsyncsetConversationPreference(..., applicationExtensionJson)
账号私有滚动消息保留setConversationMessageRetention同 iOSsetConversationMessageRetentionSetConversationMessageRetentionAsyncsetConversationMessageRetention
保存草稿setLocalDraftsetLocalDraftsetLocalDraftSetLocalDraftAsyncsetLocalDraft
读取草稿localDraftlocalDraftlocalDraftGetLocalDraftAsynclocalDraft
清除草稿clearLocalDraftclearLocalDraftclearLocalDraftClearLocalDraftAsyncclearLocalDraft

4. 用户、Push 和设备

统一能力iOSmacOSAndroidWindowsHarmonyOS
当前资料currentUserProfilecurrentUserProfilecurrentUserProfileGetCurrentUserProfileAsynccurrentUserProfile
批量资料userProfilesuserProfilesuserProfilesGetUserProfilesAsyncuserProfiles
手机号精确解析resolveUser(phoneNumber:)同 iOSresolveUserByPhoneResolveUserByPhoneAsyncresolveUserByPhone
更新资料updateCurrentUserProfileupdateCurrentUserProfileupdateCurrentUserProfileUpdateCurrentUserProfileAsyncupdateCurrentUserProfile
当前资料 + 公开扩展currentUserProfileWithApplicationExtension同 iOScurrentUserProfileWithExtensionGetCurrentUserProfileWithApplicationExtensionAsynccurrentUserProfileWithExtension
批量资料 + 公开扩展userProfilesWithApplicationExtensions同 iOSuserProfilesWithExtensionsGetUserProfilesWithApplicationExtensionsAsyncuserProfilesWithExtensions
手机精确解析 + 公开扩展resolveUserWithApplicationExtension同 iOSresolveUserByPhoneWithExtensionResolveUserWithApplicationExtensionAsyncresolveUserByPhoneWithExtension
更新资料 + 公开扩展updateCurrentUserProfileWithApplicationExtension同 iOSupdateCurrentUserProfileWithExtensionUpdateCurrentUserProfileWithApplicationExtensionAsyncupdateCurrentUserProfileWithExtension
PresencepublishPresencepublishPresencepublishPresencePublishPresenceAsyncpublishPresence
Presence 快照/在线端queryPresencequeryPresencequeryPresenceQueryPresenceAsyncqueryPresence
Presence 显式订阅subscribePresencesubscribePresencesubscribePresenceSubscribePresenceAsyncsubscribePresence
Presence 显式退订unsubscribePresenceunsubscribePresenceunsubscribePresenceUnsubscribePresenceAsyncunsubscribePresence
Presence 订阅集listPresenceSubscriptionslistPresenceSubscriptionslistPresenceSubscriptionsListPresenceSubscriptionsAsynclistPresenceSubscriptions
TypingpublishTypingpublishTypingpublishTypingPublishTypingAsyncpublishTyping
Typing 快照queryTypingqueryTypingqueryTypingQueryTypingAsyncqueryTyping
在线自定义信令publishCustomSignalpublishCustomSignalpublishCustomSignalPublishCustomSignalAsyncpublishCustomSignal
注册 PushregisterPushDeviceregisterPushDeviceregisterPushDeviceRegisterPushDeviceAsyncregisterPushDevice
禁用 PushdisablePushDevicedisablePushDevicedisablePushDeviceDisablePushDeviceAsyncdisablePushDevice
设备会话列表listDeviceSessionslistDeviceSessionslistDeviceSessionsListDeviceSessionsAsynclistDeviceSessions
撤销设备会话revokeDeviceSessionrevokeDeviceSessionrevokeDeviceSessionRevokeDeviceSessionAsyncrevokeDeviceSession

5. 好友与黑名单

统一能力iOSmacOSAndroidWindowsHarmonyOS
发好友申请sendFriendRequestsendFriendRequestsendFriendRequestSendFriendRequestAsyncsendFriendRequest
处理好友申请resolveFriendRequestresolveFriendRequestresolveFriendRequestResolveFriendRequestAsyncresolveFriendRequest
发好友申请 + 参与者可见扩展sendFriendRequest(..., applicationExtensionJSON:)同 iOSsendFriendRequestWithExtensionSendFriendRequestWithApplicationExtensionAsyncsendFriendRequestWithExtension
处理好友申请 + 扩展回显resolveFriendRequestWithApplicationExtension同 iOSresolveFriendRequestWithExtensionResolveFriendRequestWithApplicationExtensionAsyncresolveFriendRequestWithExtension
删除好友deleteFriendshipdeleteFriendshipdeleteFriendshipDeleteFriendshipAsyncdeleteFriendship
好友备注setFriendRemarksetFriendRemarksetFriendRemarkSetFriendRemarkAsyncsetFriendRemark
好友置顶setFriendPinnedsetFriendPinnedsetFriendPinnedSetFriendPinnedAsyncsetFriendPinned
好友业务扩展 JSONsetFriendApplicationExtensionsetFriendApplicationExtensionsetFriendApplicationExtensionSetFriendApplicationExtensionAsyncsetFriendApplicationExtension
批量关系检查checkRelationshipscheckRelationshipscheckRelationshipsCheckRelationshipsAsynccheckRelationships
好友申请列表friendRequestsfriendRequestsfriendRequestsListFriendRequestsAsyncfriendRequests
好友申请列表 + 扩展friendRequestsWithApplicationExtensions同 iOSfriendRequestsWithExtensionsListFriendRequestsWithApplicationExtensionsAsyncfriendRequestsWithExtensions
好友列表friendshipsfriendshipsfriendshipsListFriendshipsAsyncfriendships
搜索好友申请searchFriendRequestssearchFriendRequestssearchFriendRequestsSearchFriendRequestsAsyncsearchFriendRequests
搜索好友申请 + 扩展searchFriendRequestsWithApplicationExtensions同 iOSsearchFriendRequestsWithExtensionsSearchFriendRequestsWithApplicationExtensionsAsyncsearchFriendRequestsWithExtensions
搜索好友searchFriendshipssearchFriendshipssearchFriendshipsSearchFriendshipsAsyncsearchFriendships
关系链角标统计socialSummarysocialSummarysocialSummaryGetSocialSummaryAsyncsocialSummary
拉黑/解除setBlocksetBlocksetBlockSetBlockAsyncsetBlock
黑名单blocksblocksblocksListBlocksAsyncblocks
拉黑/解除 + 方向性私有扩展setBlock(..., applicationExtensionJSON:)同 iOSsetBlockWithExtensionSetBlockWithApplicationExtensionAsyncsetBlockWithExtension
黑名单 + 扩展blocksWithApplicationExtensions同 iOSblocksWithExtensionsListBlocksWithApplicationExtensionsAsyncblocksWithExtensions
搜索黑名单 + 扩展searchBlocksWithApplicationExtensions同 iOSsearchBlocksWithExtensionsSearchBlocksWithApplicationExtensionsAsyncsearchBlocksWithExtensions

6. 群组

统一能力iOSmacOSAndroidWindowsHarmonyOS
创建群createGroupcreateGroupcreateGroupCreateGroupAsynccreateGroup
创建群 + 群公开扩展createGroup(..., applicationExtensionJSON:)同 iOScreateGroup(..., applicationExtensionJson)CreateGroupWithApplicationExtensionAsynccreateGroup(..., applicationExtensionJson)
设置/清除群公开扩展setGroupApplicationExtension同 iOSsetGroupApplicationExtensionSetGroupApplicationExtensionAsyncsetGroupApplicationExtension
增删成员changeGroupMemberschangeGroupMemberschangeGroupMembersChangeGroupMembersAsyncchangeGroupMembers
退群leaveGroupleaveGroupleaveGroupLeaveGroupAsyncleaveGroup
解散群dismissGroupdismissGroupdismissGroupDismissGroupAsyncdismissGroup
申请入群requestGroupJoinrequestGroupJoinrequestGroupJoinRequestGroupJoinAsyncrequestGroupJoin
处理入群申请resolveGroupJoinresolveGroupJoinresolveGroupJoinResolveGroupJoinAsyncresolveGroupJoin
申请入群 + 参与者可见扩展requestGroupJoin(..., applicationExtensionJSON:)同 iOSrequestGroupJoinWithExtensionRequestGroupJoinWithApplicationExtensionAsyncrequestGroupJoinWithExtension
处理入群申请 + 扩展回显resolveGroupJoinWithApplicationExtension同 iOSresolveGroupJoinWithExtensionResolveGroupJoinWithApplicationExtensionAsyncresolveGroupJoinWithExtension
群治理changeGroupGovernancechangeGroupGovernancechangeGroupGovernanceChangeGroupGovernanceAsyncchangeGroupGovernance
设置/清除群成员业务扩展setGroupMemberApplicationExtensionsetGroupMemberApplicationExtensionsetGroupMemberApplicationExtensionSetGroupMemberApplicationExtensionAsyncsetGroupMemberApplicationExtension
群列表groupsgroupsgroupsListGroupsAsyncgroups
群成员groupMembersgroupMembersgroupMembersListGroupMembersAsyncgroupMembers
入群申请列表groupJoinRequestsgroupJoinRequestsgroupJoinRequestsListGroupJoinRequestsAsyncgroupJoinRequests
入群申请列表 + 扩展groupJoinRequestsWithApplicationExtensions同 iOSgroupJoinRequestsWithExtensionsListGroupJoinRequestsWithApplicationExtensionsAsyncgroupJoinRequestsWithExtensions
搜索群聊searchGroupssearchGroupssearchGroupsSearchGroupsAsyncsearchGroups
搜索群成员 / 入群时间筛选searchGroupMemberssearchGroupMemberssearchGroupMembersSearchGroupMembersAsyncsearchGroupMembers
搜索入群申请searchGroupJoinRequestssearchGroupJoinRequestssearchGroupJoinRequestsSearchGroupJoinRequestsAsyncsearchGroupJoinRequests
搜索入群申请 + 扩展searchGroupJoinRequestsWithApplicationExtensions同 iOSsearchGroupJoinRequestsWithExtensionsSearchGroupJoinRequestsWithApplicationExtensionsAsyncsearchGroupJoinRequestsWithExtensions
新成员历史可见策略changeGroupGovernance(.setNewMemberHistoryVisible)同 iOSchangeGroupGovernance(SetNewMemberHistoryVisible)ChangeGroupGovernanceAsync(new SetNewMemberHistoryVisible(...))changeGroupGovernance(SET_NEW_MEMBER_HISTORY_VISIBILITY)

6.1 社交投影完整性

统一能力iOSmacOSAndroidWindowsHarmonyOS
检查已加入群投影checkJoinedGroupProjectionIntegrity同 iOScheckJoinedGroupProjectionCheckJoinedGroupProjectionIntegrityAsynccheckJoinedGroupProjection
检查指定群成员投影checkGroupMemberProjectionIntegrity同 iOScheckGroupMemberProjectionCheckGroupMemberProjectionIntegrityAsynccheckGroupMemberProjection
远端刷新并原子替换群成员投影refreshGroupMemberProjection同 iOSrefreshGroupMemberProjectionRefreshGroupMemberProjectionAsyncrefreshGroupMemberProjection

检查不修复;complete=false 是强类型结果,不是 completion 错误。 刷新只有在全量无筛选分页、revision、游标、计数和唯一群主全部验证后 才原子替换本地投影。

7. 媒体

统一能力iOSmacOSAndroidWindowsHarmonyOS
图片client.sendImageclient.sendImageclient.sendImageXHIMMediaMessaging.SendImageAsyncXHIMMediaMessaging.sendImage
视频client.sendVideoclient.sendVideoclient.sendVideoXHIMMediaMessaging.SendVideoAsyncXHIMMediaMessaging.sendVideo
音频client.sendAudioclient.sendAudioclient.sendAudioXHIMMediaMessaging.SendAudioAsyncXHIMMediaMessaging.sendAudio
文件client.sendFileclient.sendFileclient.sendFileXHIMMediaMessaging.SendFileAsyncXHIMMediaMessaging.sendFile
接受上传acceptMediaUploadacceptMediaUploadacceptMediaUploadCreateMediaUploadAsyncacceptMediaUpload
接受下载acceptMediaDownloadacceptMediaDownloadacceptMediaDownloadCreateMediaDownloadAsyncacceptMediaDownload
查询任务mediaTaskmediaTaskmediaTaskGetMediaTaskAsyncmediaTask
取消任务cancelMediaTaskcancelMediaTaskcancelMediaTaskCancelMediaTaskAsynccancelMediaTask
打开缓存openMediaCacheReaderopenMediaCacheReaderopenMediaCacheReaderOpenMediaCacheReaderAsyncopenMediaCacheReader

8. Call Session

统一能力iOSmacOSAndroidWindowsHarmonyOS
邀请inviteCallinviteCallinviteCallInviteCallAsyncinviteCall
接听acceptCallacceptCallacceptCallAcceptCallAsyncacceptCall
拒绝rejectCallrejectCallrejectCallRejectCallAsyncrejectCall
结束endCallendCallendCallEndCallAsyncendCall
信令分页listCallSignalslistCallSignalslistCallSignalsListCallSignalsAsynclistCallSignals
崩溃恢复recoverCallSessionsrecoverCallSessionsrecoverCallSessionsRecoverCallSessionsAsyncrecoverCallSessions

以上入口是统一 Call Session 控制面;媒体面仍由客户选定并注入的 RTC Provider 完成。凭证不持久化,崩溃恢复只返回可恢复的会话状态。

9. Message Enricher

统一能力iOSmacOSAndroidWindowsHarmonyOS
创建 Provider FacadeXHIMMessageEnricher(provider:)同 iOSXHIMMessageEnricher(provider)new XHIMMessageEnricher(provider)new XHIMMessageEnricher(provider)
语音转文字transcribetranscribetranscribeTranscribeAsynctranscribe
翻译translatetranslatetranslateTranslateAsynctranslate
取消cancel(requestID:)cancel(requestID:)cancel(requestId)Cancel(requestId)cancel(requestId)
关闭closeclosecloseDisposeclose

Provider 由宿主注入,远端处理明文必须显式同意;SDK 不内置供应商凭证或模型。

10. 离线 Reader

统一能力iOSmacOSAndroidWindowsHarmonyOS
打开XHIMOfflineReader.openXHIMOfflineReader.openXHIMOfflineReader.openXHIMOfflineReader.OpenAsyncXHIMOfflineReader.open
消息messagesmessagesmessagesMessagesAsyncmessages
搜索searchMessagessearchMessagessearchMessagesSearchMessagesAsyncsearchMessages
会话conversationsconversationsconversationsConversationsAsyncconversations
好友申请friendRequestsfriendRequestsfriendRequestsFriendRequestsAsyncfriendRequests
好友friendshipsfriendshipsfriendshipsFriendshipsAsyncfriendships
groupsgroupsgroupsGroupsAsyncgroups
群成员groupMembersgroupMembersgroupMembersGroupMembersAsyncgroupMembers
黑名单blocksblocksblocksBlocksAsyncblocks
入群申请groupJoinRequestsgroupJoinRequestsgroupJoinRequestsGroupJoinRequestsAsyncgroupJoinRequests
关闭closeclosecloseDisposeAsyncclose

11. 通用请求取消

iOSmacOSAndroidWindowsHarmonyOS
Swift Task / XHIMRequest.cancel()Swift Task / XHIMRequest.cancel()Coroutine cancellation每个异步方法的 CancellationToken每个 Promise 可用 onRequest 取 ID,再调用 cancelRequest

这项差异是语言原生设计,不代表功能缺失。业务取消消息或媒体任务时仍应使用 对应的 durable cancel API。

12. 跨端框架

框架客户 API底层映射当前范围
FlutterXHIMSDK.metadata()Darwin/Android 原生元信息 Facade返回当前进程 Core 的 version / commit / ABI;旧 Native 缺符号显式失败
Flutterclient.events 中的 XHIMAccountStateChangedDarwin/Android 强类型原生事件BigInt revision/epoch/generation;退出后迟到和重复/低 revision 被丢弃
FlutterXHIMStandardMessageFactory.markdown / sendMarkdown / getMessageHistory / messagesByServerIds / markGroupMessagesRead / groupMessageReaders / editText / friendRequests / resolveFriendRequest / deleteFriendRequests / deleteGroupJoinRequests / createGroup / changeGroupGovernance / sendImage / acceptMediaDownload / mediaTask / openMediaCacheReader / XHIMOfflineReader.openiOS、macOS、Android 原生 FacadeMarkdown 只在 Dart 侧生成同一 protobuf envelope;可靠发送、消息历史强续页、成员已读水位、消息治理、关系链、申请删除墓碑、群治理、附件持久任务与离线只读投影继续由各端 Core 负责
FluttercurrentUserProfileWithExtension / userProfilesWithExtensions / resolveUserByPhone / updateCurrentUserProfileWithExtension / setConversationPreference / createGroup / setGroupApplicationExtension / 三个 projection 入口Darwin/Android extension-aware Facade可传 XHIMCancellationToken;写扩展时缺 dedicated bridge 稳定 unsupported
FluttersendFriendRequestWithExtension / resolveFriendRequestWithExtension / setBlockWithExtension / requestGroupJoinWithExtension / resolveGroupJoinWithExtension / 三类 *WithExtensions 列表与搜索Darwin/Android 原生投影基础模型 applicationExtensionJson == null 是 unknown;显式入口成功的空串是 authoritative clear
Electron MaingetXHIMSDKMetadata()shared Node-API 读取已加载 Core不请求 Server;旧 addon / Core 缺能力显式返回 unsupported
Electron Main / RendereronAccountStateChanged / accountStateChanged IPC eventshared Node-API + Main/Preload 固定白名单callback 内深拷贝 borrowed bytes;不允许管理员 reason 或未知属性跨 IPC
Electron MaincreateXHIMMarkdownMessage / decodeXHIMMarkdownMessage / XHIMElectronClient.messagesByServerIds / markGroupMessagesRead / groupMessageReaders / raw完整 shared Node-API bridge与 HarmonyOS NativeClient 同面;Markdown 工厂不执行渲染,逐消息已读复用 Core 的 peer watermark
Electron Main / RenderercurrentUserProfileWithExtension / userProfilesWithExtensions / resolveUserByPhone / updateCurrentUserProfileWithExtension / setConversationPreference / createGroup / setGroupApplicationExtension / 三个 projection 入口shared Node-API + 固定 IPC 白名单applicationExtensionJSON 拼写固定;基础模型字段缺失是 unknown
Electron Main / RenderersendFriendRequestWithExtension / resolveFriendRequestWithExtension / setBlockWithExtension / requestGroupJoinWithExtension / resolveGroupJoinWithExtension / 三类 *WithExtensions 列表与搜索shared Node-API dedicated symbols显式模型为 required string,空串是 clear;缺符号不回退
Electron Rendererwindow.xhimMain Process 固定 IPC 白名单默认只暴露页面需要的最小能力
Web / BrowsercreateXHIMMarkdownMessage / decodeXHIMMarkdownMessage / XHIMWebClient(含 deleteFriendRequests / deleteGroupJoinRequests / markGroupMessagesRead / groupMessageReadersTypeScript Web Lite Runtime + Protobuf Fetch/WSS + IndexedDB v2Markdown 使用同一 protobuf envelope;申请删除使用同一服务合同;消息与 peer-read Sync 在账号隔离 IndexedDB 中交易投影,支持按 ID 批量解析和逐消息已读成员
Web / Browserclient.on('accountStateChanged', listener)WSS ACCOUNT_STATE_CHANGED(17) 强类型映射会话 AbortSignal 取消在途请求;105/106 不进入凭证刷新;旧 Server 仍保持普通 revoke 行为
Web / BrowsergetXHIMSDKMetadata()prebuild 生成的 npm 版本 / Git 来源 + protocol fingerprintabiVersion=null;脏工作区标记 +dirty,绝不从 Server 接口伪造客户端 SDK 版本
Web / BrowsergetCurrentUserProfile / getUserProfiles / resolveUserByPhone / updateCurrentUserProfile / setConversationPreference / createGroup / setGroupApplicationExtension / 三个 projection 入口真实 Server HTTP protobuf + IndexedDB projectionWeb 不加载本地 Core;返回扩展是 canonical string,空串为服务端权威 unset
Web / BrowsersendFriendRequestWithExtension / resolveFriendRequestWithExtension / setBlockWithExtension / requestGroupJoinWithExtension / resolveGroupJoinWithExtension / list*WithExtensions / searchSocialWithExtensions当前 Server 等价能力AbortSignal 直达 fetch;黑名单扩展是方向性账号私有数据
小程序XHIMMiniProgramClient.create 返回受管 XHIMWebClient微信 wx.request / wx.connectSocket / 账号隔离原子快照复用 Web 的 126 项 Server 能力;不伪造浏览器 IndexedDB 或原生媒体 Core
小程序createXHIMWeChatMiniProgramAdapter(wx)可替换平台 Adapter支付宝/抖音保持同一 request/socket/storage 合同,必须由目标平台消费工程验收

Web 的独立接入和 API 表见 Web QuickStart,Electron 见 Electron QuickStart,小程序见 Mini Program QuickStart。这三端已进入 独立 API 页的平台选择器;没有真实公开入口的能力会显示 “当前平台未提供”。React Native、Unity 和 uni-app 的安装与调用流程见 选择平台与接入说明

12.1 扩展值与旧 Core 兼容合同

  • 基础 friendRequests / blocks / groupJoinRequests 及其基础处理入口在旧 Core 上继续成功;其 nullable/缺失扩展表示 unavailable/unknown。
  • 显式 *WithExtension(s) 成功时才能将空字节/空串解释为当前 Core/服务端证明的 authoritative clear。
  • 带扩展的发送、建群、会话偏好和关系写入只调用 dedicated capability-fenced 入口;旧 Core 缺符号时在变更前返回 UNSUPPORTED,绝不回退基础 API 而静默忽略扩展。
  • 新 Core 还必须在变更前确认对应的 Server capability family;旧 Server 未声明能力时同样 fail-closed UNSUPPORTED,不发出会被旧服务端忽略的 tail。weak symbol 只是旧 Core 兼容的第一道栅栏,不能替代服务能力协商。
  • 原生 C ABI 所有返回 view 都是 callback 期借用内存;Apple、Android、 Windows、HarmonyOS 在完成 async/callback 前已深拷贝。错误、日志和 description/ToString() 不记录 JSON 正文。

XHIM 客户端 SDK 与服务端文档