TIM

TIM

TIM 是 IM Web SDK 的命名空间,提供了创建 SDK 实例的静态方法 create() ,以及事件常量 EVENT,类型常量 TYPES
v2.27.0 起,我们新增了支持 ES6 Module 规范的 SDK(默认 UMD 规范),开发者可以根据项目情况按需集成。详细说明如下:

Web 项目集成 tim-js-sdk

tim-js-sdk 说明 模块规范 v2.26.0 文件大小(单位 KB) v2.27.0 文件大小(单位 KB)
tim-js.js 默认 SDK,不支持好友关系链 UMD 679 559
tim-js.es.js 不支持好友关系链 ES6 Module N/A 487
tim-js-friendship.js 支持好友关系链 UMD 716 597
tim-js-friendship.es.js 支持好友关系链 ES6 Module N/A 519

小程序 & uni-app 项目集成 tim-wx-sdk

tim-wx-sdk 说明 模块规范 v2.26.0 文件大小(单位 KB) v2.27.0 文件大小(单位 KB)
tim-wx.js 默认 SDK,不支持好友关系链 UMD 592 559
tim-wx.es.js 不支持好友关系链 ES6 Module N/A 487
tim-wx-friendship.js 支持好友关系链 UMD 630 597
tim-wx-friendship.es.js 支持好友关系链 ES6 Module N/A 519

如果您想快速体验通即时通信 IM 的 Demo,请参考文档:快速入门(Web & H5)

Web 小程序 uni-app

如果您的业务需要实时音视频通话功能,请参考文档: 使用音视频通话

Web 小程序 uni-app
  • 如果您的业务有出海需求,请参考文档:出海指南
  • 如果您的业务需要内容审核(反垃圾信息)功能,请参考文档:内容审核
  • 如果您的业务需要私有化部署,请参考文档:私有化支持

Methods

(static) create(options) → {Object}

即时通信 IM Web SDK 的工厂函数,用于生成 SDK 实例。
接入前,您需要在 云通信控制台 中创建一个云通信应用,并取得 SDKAppID

Examples
let options = {
  SDKAppID: 0 // 接入时需要将0替换为您的云通信应用的 SDKAppID,类型为 Number
};
let tim = TIM.create(options); // SDK 实例通常用 tim 表示
let options = {
  SDKAppID: 0, // 接入时需要将0替换为您的即时通信应用的 SDKAppID
  proxyServer: `ws://${server_ip}:${server_port1}`, // WebSocket 服务器代理地址
  fileUploadProxy: `http://${server_ip}:${server_port2}`, // 图片、视频、文件上传代理地址
  fileDownloadProxy: `http://${server_ip}:${server_port3}` // 图片、视频、文件下载代理地址
};
let tim = TIM.create(options); // SDK 实例通常用 tim 表示
Parameters:
Name Type Description
options Object required

配置

Properties
Name Type Description
SDKAppID Number required

云通信应用的 SDKAppID。如果您的业务有出海需求,请参考 出海指南

proxyServer String | undefined

WebSocket 服务器代理地址(小程序平台不支持使用 IP 地址)

fileUploadProxy String | undefined

图片、视频、文件上传代理地址。v2.27.0起支持(小程序平台不支持使用 IP 地址)

fileDownloadProxy String | undefined

图片、视频、文件下载代理地址。v2.27.0起支持(小程序平台不支持使用 IP 地址)

Returns:

SDK 实例

Type
Object