TencentCloudChat

TencentCloudChat

TencentCloudChat 是腾讯云即时通信 IM Web SDK 的命名空间,提供了创建 SDK 实例的静态方法 create() ,以及事件常量 EVENT,类型常量 TYPES, 信令常量 TSignaling

Web & 小程序 & uni-app 项目使用同一个 SDK集成指引

SDK 文件目录结构:

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

Web 小程序 uni-app

如果您使用 uni-app 开发终端应用,并且需要推送功能,请参考文档:uni-app 快速接入 TIMPush

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

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

Methods

(static) create(options) → {Object}

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

Examples
let options = {
  SDKAppID: 0 // 接入时需要将0替换为您的云通信应用的 SDKAppID,类型为 Number
};
let chat = TencentCloudChat.create(options); // SDK 实例通常用 chat 表示
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 chat = TencentCloudChat.create(options); // SDK 实例通常用 chat 表示
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 地址)

eventThrottling Boolean | undefined

事件节流选项,v3.2.6起支持。SDK 默认开启事件节流,设置为 false 则关闭事件节流,以下事件将不受1次/秒的限制,会导致 UI 刷新更频繁,请谨慎使用。

Returns:

SDK 实例

Type
Object