本文介绍如何将 NIM Web 含圈组版 SDK 集成到您的浏览器项目。

SDK 简介

NIM Web SDK（含圈组）为 NIM Web SDK （以下简称为“原版”）的重构版本。含圈组版继承了原版的特性，提供完善的即时通讯功能开发框架和简洁的 API 接口，方便您快速将即时通讯功能集成到您的 PC/移动 Web 应用及 NodeJS、微信小程序等跨平台应用。

相较于原版，含圈组版做了如下改进：

• 使用 TypeScript 重构（TypeScript 完全兼容 JavaScript 语法），使 API 出入参数定义更加完善。
• 使用 Promise API 替代回调函数。
• 支持更多开发环境：现支持 IE v11.0.0 及以上版本和 chrome v4.0.0 及以上版本等浏览器，以及微信小程序、支付宝小程序、uni-app 等跨平台开发环境。

• 结构更精简。包体积降至原版 SDK 的 40%。

uni-app 和小程序环境的集成说明，请分别参见：

• 集成 SDK（uni-app）
• 集成 SDK（小程序）

集成 SDK

步骤1：安装 SDK

SDK 以 npm 包的形式提供，请前往 nim-web-sdk-ng 获取 npm 包。

通过以下命令安装 SDK。

npm install nim-web-sdk-ng@latest

SDK 结构如下：

dist/
├── CHATROOM_BROWSER_SDK.js  聊天室浏览器适配版 UMD 格式
├── CHATROOM_MINIAPP_SDK.js  聊天室小程序适配版 UMD 格式
├── CHATROOM_UNIAPP_SDK.js   聊天室 UNIAPP 适配版 UMD 格式
├── NIM_BROWSER_SDK.js       IM 浏览器适配版 UMD 格式
├── NIM_MINIAPP_SDK.js       IM 小程序适配版 UMD 格式
├── NIM_UNIAPP_SDK.js        IM UNIAPP 适配版 UMD 格式
├── QCHAT_BROWSER_SDK.js     圈组浏览器适配版 UMD 格式

步骤2：通过 import 命令引入 SDK

请根据您的实际开发环境和需求导入相应的 SDK 文件并初始化对应的 SDK 实例。

开发需求	环境	SDK 导入
IM 功能	浏览器	import NIMSDK from 'nim-web-sdk-ng/dist/NIM_BROWSER_SDK'
聊天室功能	浏览器	import ChatroomSDK from 'nim-web-sdk-ng/dist/CHATROOM_BROWSER_SDK'
圈组功能	浏览器	import QChatSDK from 'nim-web-sdk-ng/dist/QCHAT_BROWSER_SDK'

后续步骤

集成 SDK 后，需初始化 SDK 实例。 NIM 实例、Chatroom 实例和圈组（QChat）实例需分别使用不同的初始化方法，具体参见：

• 初始化并登录 IM
• 初始化并登录聊天室
• 初始化并登录圈组

常见问题

Q：执行 npm 命令安装 SDK 失败，出现以下报错信息。

A：出现该问题是由用户侧环境导致，请按照提示执行 npm fund和npm audit fix即可。