Skip to content

选择平台与接入说明

本页只用来帮你找到正确的 SDK 接入页。每个平台只有一个主入口;安装方式、 可选 UI、Demo 和高级 API 都在该平台页内继续选择。

XHIM 的产品介绍、版本方案和商业信息请查看 XHIM 产品页。本站专注于 SDK 使用和 Demo 二次开发。

1. 选择你的平台

你正在开发从这里开始页内默认示例可直接运行的 Demo
iPhone / iPad AppiOSSwift Completion,再选 CocoaPods 或 Swift Packagexhim-ios-app
Android AppAndroidJava、CompletableFuture、XML/ViewBindingxhim-android-app
HarmonyOS AppHarmonyOSArkTS、Promise、ArkUIxhim-harmony-app
macOS AppmacOSSwift Completionxhim-macos-app
Windows AppWindowsC# Task 与 WPFxhim-windows-app
浏览器网站WebTypeScript,可配合 React/Vue/Sveltexhim-web-app
Electron 桌面应用ElectronMain / Preload / Rendererxhim-electron-app
Flutter AppFlutterDart,页内可继续选 UI Kitxhim-flutter-app
React Native AppReact NativeTypeScript,Android 宿主与 Native Module 使用 Javaxhim-react-native-app
Unity 游戏UnityC#xhim-unity-app
uni-appuni-app页内选 H5、App 或小程序运行时xhim-uni-app
微信或其他小程序小程序TypeScript,微信可直接使用内置 Adapterxhim-mini-program-app

Web 和 Electron 怎么选

  • 页面在 Chrome、Safari、Edge 等普通浏览器中运行:选 Web;
  • 应用由 Electron 打包为 Windows/macOS/Linux 桌面程序:选 Electron;
  • 两者的安装包不能混用。

Android 为什么默认是 Java

Android 主接入使用 Java + CompletableFuture + Listener,方便现有 Java/XML、 MVP 或 MVVM 项目直接接入。Kotlin Coroutine/Flow 入口仍然保留,但不作为 新项目文档的默认示例。

2. 每个平台都按这个顺序接入

text
1. 领取 Server URL、App ID 和测试账号
2. 安装当前平台的固定版本 SDK
3. 在账号层创建 Client
4. 注册连接和数据变化监听
5. 连接当前账号
6. 创建或查询会话,发送第一条消息
7. 用第二个账号验证接收、已读和断网恢复
8. 验证登出、换号和资源释放

各平台的方法名和异步写法不同,但业务顺序相同。完成首条消息之前, 只需准备账号、服务地址和当前平台的 SDK 包。

3. 接入前需要的信息

参数由谁提供说明
Server URLXHIM 服务端负责人例如 https://im-test.example.com
App IDXHIM 服务端负责人某些平台使用 Server 默认值,以当前页面为准
当前用户 ID你的业务账号系统必须与当前 App 登录用户一致
XHIM 访问凭证你的业务后台正式环境使用短期凭证,不在客户端写入管理密钥
对端用户 ID测试账号用于验证首条消息

Development 环境如果已启用测试登录,平台 QuickStart 会给出更短的连接示例。 正式环境一律使用业务后台凭证。

4. 下一步

  • 还没有选定平台:从本页第 1 节选择主入口;
  • 已经能发送消息:查看 API Reference
  • 准备改 UI、Repository 或自定义消息:查看 客户端二次开发
  • 连接失败或收不到消息:先查看当前平台页底部的“常见问题”。

XHIM 客户端 SDK 与服务端文档