SuperAPI AI 工具集

cometchat-react-native-features

编程与开发

查看项目

更新于 10-21 20:29

技能介绍

用途

该技能用于在 React Native 应用中开启某个具名的 CometChat 能力。它不依赖记忆,而是以 features.rn-v5.json(48 条)与 catalog rn-v5.json 作为事实依据:先查特性条目,再按条目指示走对应分支。若在 features.rn-v5.json 中找不到条目,则该特性不存在,应如实说明,而不是编造 API。

主要能力

特性条目包含以下字段,用于决定后续动作:

  • category · enablement:决定走哪个分支。
  • ui_components:需要渲染的组件(均经 catalog 校验)。
  • sdk_fallback:当 kit 没有对应组件时使用的 SDK 方法。
  • needs_stitching:需要接入宿主状态,而非仅挂载组件。
  • needs_dashboard:除代码外还需仪表盘开关。
  • auto_rendered_ui:由 kit 自动渲染,无需写客户端代码。
  • platform_delta:React Native 与 React 的差异,写代码前需先阅读。
  • docs_gap:文档尚未覆盖,应标记而非自行补全。

使用方式

第一步,在 oracle 中查找特性条目。第二步,只走一个分支:

A. 已默认开启(category: default,enablement: auto,共 12 个特性)。无需启用。Reactions、mentions、typing indicators、receipts、threads、attachments 在 v5 中属于核心消息能力,不是扩展。不要把它们当作“需启用的扩展”提供;仪表盘仍列出的旧版 Reactions 与 Mentions 扩展,其文档已说明属于核心并计划弃用。定制应通过组件 props 完成。

B. 仪表盘扩展(enablement: dashboard-extension,共 20 个特性)。先在 CometChat 仪表盘启用,再接入 ui_components。包括 polls、stickers、translation、link preview、whiteboard、document 等。缺少仪表盘步骤时代码可编译但静默无效。部分为 auto_rendered_ui: true(如 polls 气泡),启用后消息列表自动渲染,无需写客户端代码,手写会产生重复 UI。

C. AI(category: ai,needs_dashboard: true,共 4 个特性)。两步,第二步常被遗漏:在仪表盘启用并在代码中设置 prop。prop 默认关闭,只改仪表盘看起来像没生效。包括 smart replies、conversation starter、conversation summary、AI assistant。prop 名称需从 /ui-kit/react-native/ai-features.md 获取,不要猜测。

D. npm 包(enablement: npm-package,共 2 个特性)。仅通话。React Native 需要自己的 calls SDK:

npm install @cometchat/calls-sdk-react-native@5 # + its 6 pinned peer deps — exact list in cometchat-react-native-calls cd ios && pod install

注意:不是 @cometchat/calls-sdk-javascript,那是 Web 包,无法使用。其 peer 依赖包含 react-native-webrtc(原生模块),需声明摄像头与麦克风权限(NSCameraUsageDescription / NSMicrophoneUsageDescription;CAMERA / RECORD_AUDIO)。模拟器无法采集摄像头或麦克风,通话必须在真机验证。详细内容见 cometchat-react-native-calls。

E. SDK 回退(kit 无组件,共 3 个特性)。Kit v5 移除了详情与管理界面,sdk_fallback 给出方法:

  • group-member-management:无添加/封禁/转让组件,使用 addMembersToGroup · banGroupMember · unbanGroupMember · transferGroupOwnership · BannedMembersRequestBuilder。
  • user-group-details:无详情组件,使用 getUser · getGroup · updateGroup。
  • call-log-details:仅提供列表,使用 CometChatCalls.CallLogRequestBuilder(calls SDK)。

被封禁成员没有任何 UI 界面。能封禁却无法查看或解封是不完整的闭环,应同时实现两端。不要自行发明布局,可参考官方示例应用实现(github.com/cometchat/cometchat-uikit-react-native/tree/v5/examples/SampleApp)。这些是示例应用目录路径,不是导入路径。

第三步,只接入分支所需内容。渲染条目中的 ui_components,不渲染其他。auto_rendered_ui 特性不写客户端代码;needs_stitching 特性需接入宿主状态与回调,而非仅挂载。不要因为看似相关就启用相邻特性,那属于未请求的范围。

适用场景

当需要“启用 reactions / polls / translation / stickers”“开启 smart replies”“添加语音和视频通话”“X 是否支持”“如何开启 Y”时使用本技能。前置条件除核心技能外通常无额外要求,仅两个特性需要安装包。

限制与已知问题

已知文档缺口(应标记,不要自行补全):reactions · typing-indicators · delivery-read-receipts · media-file-attachments(整个多附件集群)以及上述三个 SDK 回退特性带有 docs_gap 标记。应基于 catalog 与 kit 源码构建,并告知开发者该页面缺失。

常见陷阱:把 reactions/mentions 当作扩展提供(v5 中为核心,仪表盘条目为旧版);只开仪表盘未设 prop(AI 特性代码默认关闭);安装 Web 版通话 SDK(RN 有自己的);对 auto_rendered_ui 特性手写代码(产生重复 UI);假设特性存在(无 oracle 条目即无特性);在模拟器上测试通话(无法采集摄像头或麦克风)。

验证方式:特性在 features.rn-v5.json 中有条目且走了对应分支;每个输出的组件都出现在 catalogs/rn-v5.json 中;npm run verify:fences:rn-v5 通过;在真机上能力确实出现——受仪表盘控制的特性若未改代码,或改了代码但未做仪表盘步骤,都会静默无效果而非报错。