SDKsMini Program
OpenIM 小程序 SDK 概览
以 WASM 文档为共享 API 基线,说明小程序运行时差异以及相对 WASM 不可用的本地搜索与清理 API。
OpenIM 小程序 SDK 适用于小程序和轻量 Web 场景。用户、会话、消息、群组和事件的方法级模型与其他 OpenIMClientSDK 保持一致,但不提供本地消息存储,也不提供若干依赖本地库的搜索与清理 API。共享能力请直接阅读 WASM SDK 文档;本页只说明运行时差异和不可用清单。
与 WASM 的关系
- 方法语义、事件和数据模型:以对应 WASM 指南为准。
- 差异集中在:初始化入口、域名白名单、文件选择与上传、平台生命周期,以及下表列出的不可用 API。
- 需要完整本地消息库、会话缓存和历史持久化的 Web 客户端,应优先使用 WASM SDK。
不可用 API(相对 WASM)
小程序 SDK 当前不提供下列方法。产品设计不要依赖本地全文搜索或本地清空会话历史;改为业务后端检索,或使用仍可用的分页查询后在应用内过滤。
| 不可用 API | WASM 参考 | 建议替代 |
|---|---|---|
clearConversationAndDeleteAllMsg | 清空会话消息 | 由服务端策略或业务接口处理历史清理;客户端只刷新当前会话视图 |
searchLocalMessages | 搜索消息 | 使用可信后端消息索引,再按返回的 conversationID / clientMsgID 打开会话 |
searchFriends | 搜索好友 | 分页拉取好友后在应用内过滤,或由业务通讯录搜索 |
searchGroupMembers | 搜索群成员 | 使用 getGroupMemberList 分页后过滤,或后端成员搜索 |
searchGroups | 搜索群组 | 使用已加入群组分页接口后过滤,或后端群发现 |
findMessageList | 按 ID 查找消息 | 保留服务端或会话态中的消息 ID,再通过可用的历史查询接口加载上下文 |
共享能力(链到 WASM)
运行环境注意事项
- 测试登录前配置允许访问的 request、WebSocket 和上传域名。
- 业务逻辑不要依赖 SDK 本地消息数据库或本地会话持久化;页面恢复后重新同步必要数据。
- 文件消息需结合目标平台的文件选择、临时路径、上传 API 和大小限制验证。
- Token 仍由可信后端签发,客户端只接收短期凭证。
- 在 Web 中使用小程序 SDK 时,应限定轻量场景;完整 Web IM 客户端仍建议使用 WASM SDK。
这个页面有帮助吗?