文档中心>即时通信 IM>无 UI 集成>集成 SDK>小程序多端框架(Donut)

小程序多端框架(Donut)

最近更新时间:2024-05-20 17:27:21

我的收藏
本文主要介绍如何快速将腾讯云即时通信 IM SDK 集成到您的微信多端框架 Donut 项目中。

开发环境要求

熟悉微信小程序开发。
了解 微信多端框架 Donut,熟悉相关概念和产品功能。
下载版本号 ≥ 1.06.2306272 的微信开发者工具(开发版)

集成 SDK

在您的项目中使用 npm 安装相应的 IM SDK 依赖。
npm install @tencentcloud/chat
// 发送图片、文件等消息需要腾讯云即时通信 IM 上传插件
npm install tim-upload-plugin --save
说明:
若同步依赖过程中出现问题,请切换 npm 源后再次重试。
npm config set registry http://r.cnpmjs.org/

构建 npm

微信开发者工具 -> 工具 -> 构建 npm。构建成功后,项目会新增 miniprogram_npm 文件夹。


引入 SDK

// 如果您已集成 v2.x 的 SDK,想升级到 V3 并且想尽可能地少改动项目代码,可以继续沿用 TIM
// import TIM from '@tencentcloud/chat';
import TencentCloudChat from '@tencentcloud/chat';
import TIMUploadPlugin from 'tim-upload-plugin';

let options = {
SDKAppID: 0 // 接入时需要将0替换为您的即时通信 IM 应用的 SDKAppID
};
// 创建 SDK 实例,`TIM.create()`方法对于同一个 `SDKAppID` 只会返回同一份实例
let chat = TencentCloudChat.create(options); // SDK 实例通常用 chat 表示

chat.setLogLevel(0); // 普通级别,日志量较多,接入时建议使用
// chat.setLogLevel(1); // release 级别,SDK 输出关键信息,生产环境时建议使用

// 注册腾讯云即时通信 IM 上传插件
chat.registerPlugin({'tim-upload-plugin': TIMUploadPlugin});

启用 Network SDK 并构建应用

腾讯云即时通信 IM SDK 使用了 websocket 作为底层通信通道,因此,您需要在构建应用前,在 project.miniapp.json > 扩展 SDK 配置 > Network SDK,勾选启用 Network SDK, websocket 相关功能
注意:
请务必启用 Network SDK,否则 App 运行后将会出现 js 运行时错误。