跳到主要内容

版本:5.X

正确使用 rongcloud-im 集成 Web IMLib

本页说明如何在 Web 项目中正确使用 rongcloud-im,包括描述业务目标、指定 IMLib 约束、编写集成任务,以及检查生成代码和验证结果。

使用 rongcloud-im Skill 集成融云 IM 时,请清楚说明项目现状、业务目标和 SDK 约束,并要求 AI 先查文档、再检查项目,最后验证结果。

正确使用步骤

  1. 说明项目环境:告知目标平台(Android、iOS、Web 或 Flutter),并要求 AI 检查项目中已安装的 SDK 和版本。
  2. 说明业务目标:明确要实现的功能和会话类型,例如单聊、群组、超级群或聊天室。
  3. 说明 SDK 选择:如果已经决定使用 IMKit 或 IMLib,请将其写成明确约束;如果尚未决定,请让 AI 根据项目和业务需求推荐。
  4. 准备必要凭据:开始集成前,先阅读下方的凭据和占位符规则。
  5. 要求先查证再实现:让 AI 先阅读当前平台的官方文档,再根据项目已安装的 SDK 检查 API 和版本差异。
  6. 要求验证并报告:实现后运行适用的构建、类型检查或测试,并报告已实现功能、未实现功能、范围外项目和待办事项。

凭据和占位符

集成融云 IM 需要两个凭据:

  • App Key:用于客户端初始化 SDK,可在融云控制台获取。
  • 用户 Token:用于客户端连接融云服务器,由 App 服务端调用注册用户接口获取。

只有提供了真实凭据,AI 生成的初始化和连接代码才能实际运行。如果暂时没有凭据,仍然可以让 AI 进行方案分析、代码审查和文档查询,只是无法运行验证。

如果你要求生成可运行代码但没有提供凭据,AI 会先向你索要凭据,而不是直接生成代码。只有当你明确表示接受不可运行的脚手架代码时,AI 才会以 YOUR_APP_KEYYOUR_TEST_TOKEN 这样的占位符代替真实凭据,供你之后替换。此时请要求 AI 将所有占位符列入 TODO 清单,避免遗漏替换。

警告

App Secret、签名逻辑和 Token 生成代码只能存在于 App 服务端,不得出现在客户端代码中。

集成任务提示词

以下提示词可根据任务类型调整。请尽量明确平台、业务场景和会话类型;如果已经确定 SDK,请一并明确指定。

查询能力和限制

text
使用 `rongcloud-im` 查询当前平台是否支持以下能力:
<功能或限制问题>

请先读取官方能力文档,只回答能力、限制、适用会话类型和待复核项,不要修改代码。

推荐 SDK 并集成

text
使用 `rongcloud-im` 为当前项目推荐并实现融云 IM 集成方案。

业务场景:
<说明用户需要完成的操作>

要求:
1. 从项目文件识别平台、现有 SDK、版本和已有初始化代码。
2. 确认单聊、群组、超级群或聊天室等目标会话类型。
3. 我未指定 SDK,请根据业务需求、会话类型和项目现状推荐 IMKit 或 IMLib,并说明理由。
4. 修改代码前,先完整阅读当前平台对应的融云文档,再用已安装 SDK 验证 API。
5. 混合会话需求按 IMKit 和 IMLib 的覆盖范围拆分。
6. 分别说明客户端、App 服务端、融云 Server API,以及回调或 Webhook 的职责。
7. 完成后运行适用的构建、类型检查或测试,并输出已实现、未实现、范围外和 TODO 清单。

指定 IMKit

text
使用 `rongcloud-im` 集成当前平台的 IMKit,并将 IMKit 作为明确约束。

先识别项目和版本,再读取对应的 IMKit 文档。优先使用 IMKit 已提供的页面、组件、配置、主题、Hook 和其他公开扩展能力。如果仍无法满足需求,请说明限制和可选方案,不要直接改用 IMLib,也不要直接修改 IMKit 源码。

指定 IMLib

text
使用 `rongcloud-im` 集成当前平台的 IMLib,并将 IMLib 作为明确约束。

先识别项目和版本,再读取对应的 IMLib 文档,并根据当前安装版本核对 API。不要仅因为 IMKit 开发成本更低而改变 SDK;如果 IMLib 无法满足需求,请说明限制和可选方案,不要直接改用 IMKit。

根据截图或原型生成方案

text
使用 `rongcloud-im` 分析这些即时通讯截图或原型,并为当前项目生成实现方案。

要求:
1. 多张图片先清点、标记和去重。
2. 丢弃营销页、第三方品牌元素和水印。
3. 将登录/注册归为应用认证,将通话/会议归为 RTC/Call 范围。
4. 输出功能清单,说明哪些功能可直接实现、需要定制、只能部分实现、需要 App 服务端支持或不属于 IM SDK。
5. 写代码前先让我确认受限功能和替代方案。
6. 确认后读取当前平台文档和已安装 SDK,再实现支持的功能。
7. 最终输出已实现、未实现、范围外和 TODO 清单,不要静默省略或编造不支持的 API。

验证集成结果

提交代码前,请确认 AI 已报告以下信息:

  • 识别到的平台、SDK 和版本。
  • 业务场景、会话类型、SDK 约束和方案选择理由。
  • 使用的官方文档及 API 验证方式。
  • App Key 和 Token 的来源,且客户端代码中没有 App Secret 或签名逻辑。
  • 修改的文件、构建、类型检查或测试结果,以及仍需完成的 TODO。

如果存在官方文档与安装版本的冲突、网络请求失败或未确认的 API,AI 必须明确标记,而不是静默忽略。

后续步骤

如需通过 AI 编程工具查询或管理融云控制台配置,可继续配置 MCP