多端 API 浏览器
本页用于快速查找 Client SDK 方法在不同平台上的调用方式。上方交互式浏览器支持按模块搜索 API,并按平台展示:
- 方法原型
- 入参字段、类型与必填性
- 返回值字段与类型
- 最小调用示例
怎么查
- 在左侧搜索框输入方法名,例如
sendMessage、listConversations、subscribeEvents。 - 选择目标平台,例如 iOS、Android、Flutter、Web / Electron / MiniProgram、React Native、uni-app 或 HarmonyOS。
- 查看方法原型、输入参数、返回结果和代码示例。
常用模块
| 模块 | 入口 | 用途 |
|---|---|---|
| Session | client | 初始化、登录、退出、释放资源 |
| Connection | client.connection | 查询连接状态、主动断开连接 |
| Conversations | client.conversations | 会话列表、已读、置顶、草稿、归档 |
| Message Builder | client.messageBuilder | 构建文本、图片、文件、富文本等消息 |
| Messages | client.messages | 发送、查询、撤回、编辑、删除、反应 |
| Sync | client.sync | 会话和消息同步 |
| Presence | client.presence | 用户在线态与订阅 |
| Media | client.media | 上传、下载 URL、缓存与访问控制 |
| Capabilities | client.capabilities | 可选能力发现与调用 |
| Events | client.events | 事件订阅与取消订阅 |
| Diagnostics | client.diagnostics | SDK 版本与基础诊断信息 |
推荐用法
- 初始化和登录流程先参考 Client SDK 使用指南。
- 按平台安装与入口对象参考 平台包选择。
- 只查方法名、请求类型和返回类型时参考 Client API 全表。