Tutorial: V4 集成指引

V4 集成指引

V4 SDK (@tencentcloud/lite-chat) 是 V3 SDK (@tencentcloud/chat) 的优化和升级版本,V4 版本已完全覆盖 V3 提供的所有功能。升级前请先阅读 V4 和 V3 对比

V4 SDK 版本选择

V4 版本 大小 (Size) 导入路径 (Import Path) 业务场景 (Scenario)
精简版 (Basic) 200 KB import TencentCloudChat from '@tencentcloud/lite-chat/basic'; * 初始化,事件监听。
* 登录登出。
* 支持文本消息收发。
* 支持自定义消息收发(可自由定制发送内容)。
* 支持用户资料和用户状态。
标准版 (Standard) 516 KB import TencentCloudChat from '@tencentcloud/lite-chat'; (默认) 包含精简版全部功能外
* 支持获取历史消息、消息操作、合并转发、已读回执、消息扩展等功能。
* 支持图片消息、视频消息、语音消息、文件消息收发功能。
* 支持云端消息(Message)搜索、用户(User)搜索、群组(Group)搜索、群成员搜索等功能。
* 支持会话列表、会话资料、会话操作等功能。
* 支持群组管理、群成员管理等功能。
* 支持社群。
* 支持直播群。
完整版 (Professional) 609 KB import TencentCloudChat from '@tencentcloud/lite-chat/professional'; 包含标准版全部功能外
* 支持黑名单、好友管理、好友分组等功能。
* 支持关注和粉丝功能。
* 支持会话分组。
* 支持话题。

1.下载 Chat SDK V4

Web & 小程序 & uni-app 请通过 npm 下载 SDK。

npm install @tencentcloud/lite-chat --save

2. npm 集成

npm install @tencentcloud/lite-chat
// 若同步依赖过程中出现问题,请切换 npm 源后再次重试
npm config set registry http://r.cnpmjs.org/

3. 从 V3 升级为 V4

如果您的项目已经集成了 V3 版本的 Chat SDK,想升级到 V4,需要更改 SDK 依赖和引用路径。

V4 和 V3 对比

V3

import TencentCloudChat from '@tencentcloud/chat';

V4

import TencentCloudChat from '@tencentcloud/lite-chat';

4. 引入 V4 SDK

V4 SDK 允许您根据应用所需功能,按需引入精简版、标准版或完整版,以优化代码体积。

// 标准版 (默认引用,推荐)
import TencentCloudChat from '@tencentcloud/lite-chat';


// 精简版 (只包含核心聊天和用户管理,体积最小)
// import TencentCloudChat from '@tencentcloud/lite-chat/basic';


// 完整版 (包含所有社交功能,如好友关系链等)
// import TencentCloudChat from '@tencentcloud/lite-chat/professional';


const SDKAppID = 0;  // 接入时需要将0替换为您的即时通信 IM 应用的 SDKAppID


// 创建 SDK 实例,`TencentCloudChat.create()`方法对于同一个 `SDKAppID` 只会返回同一份实例
let chat = TencentCloudChat.create({
    SDKAppID
}); // SDK 实例通常用 chat 表示

交流与反馈

点此进入IM社群,享有专业工程师的支持,解决您的难题。