跳到主要内容

导入 SDK

兼容说明​

与小程序端音视频 SDK 的兼容性：

  • IMLib 5.X SDK 与 CallLib 3.X SDK 不兼容：融云暂未提供 5.X 版本的小程序端 CallLib SDK。如果您的小程序项目需要支持音视频通话（呼叫）业务，仅可使用 CallLib 3.X SDK，且目前必须配合使用即时通讯小程序端 IMLib 4.X SDK。
  • IMLib 5.X SDK 与 RTCLib 3.X SDK 不兼容：基于 IMLib 5.X 开发的即时通讯小程序，可直接使用小程序端 RTCLib 5.X SDK 使用融云的音视频会议业务。

导入 SDK​

提示

IMLib 对 Typescript 的使用者提供了友好的类型化支持，推荐开发者使用 Typescript 进行业务开发以提升代码健壮性及可维护性。

依赖安装

shell
# 安装 IM 5.0 最新版本
npm install @rongcloud/engine@latest @rongcloud/imlib-next@latest -S

代码集成

JavaScript
// 非 ESModule
const RongIMLib = require('@rongcloud/imlib-next')
// ESModule
import * as RongIMLib from '@rongcloud/imlib-next'

按需导入​

从 5.48.0 版本开始，SDK 优化了 NPM 包的 Tree Shaking 效果。若您的小程序工程使用支持 Tree Shaking 的构建工具，可按需导入实际使用的 API，并保留 ES Module 语法，使构建工具移除未使用的代码：

JavaScript
import { addEventListener, connect, Events, init } from '@rongcloud/imlib-next';

init({ appkey: '<Your-App-Key>' });
addEventListener(Events.MESSAGES, (event) => {
  console.log(event.messages);
});
connect('<Your-Token>').then((res) => {
  console.log('连接结果：', res.code);
});

请保持 @rongcloud/engine 与 @rongcloud/imlib-next 的版本一致。实际打包体积取决于小程序构建工具对 ES Module 与 Tree Shaking 的支持情况。