JSPM

  • Created
  • Published
  • Downloads 98
  • Score
    100M100P100Q87807F
  • License ISC

Tencent Cloud IM SDK for WX mini app

Package Exports

  • tim-wx-sdk
  • tim-wx-sdk/tim-wx.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tim-wx-sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

本文主要介绍如何快速地将腾讯云 IM SDK 集成到您的小程序项目中,只要按照如下步骤进行配置,就可以完成 SDK 的集成工作。

准备工作

在集成 Web SDK 前,请确保您已完成以下步骤,请参见 一分钟跑通 Demo

  • 创建了腾讯云即时通信 IM 应用,并获取到 SDKAppID。
  • 获取密钥信息。

集成 SDK

您可以通过以下方式集成 SDK:

NPM 集成

在您的项目中使用 npm 安装相应的 IM SDK 依赖。

小程序项目:

// IM 小程序 SDK
npm install tim-wx-sdk --save
// 发送图片、文件等消息需要的上传插件
npm install tim-upload-plugin --save

在项目脚本里引入模块,并初始化。

import TIM from 'tim-wx-sdk';
import TIMUploadPlugin from 'tim-upload-plugin';

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

// 设置 SDK 日志输出级别,详细分级请参见 setLogLevel 接口的说明
tim.setLogLevel(0); // 普通级别,日志量较多,接入时建议使用
// tim.setLogLevel(1); // release级别,SDK 输出关键信息,生产环境时建议使用

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

// 接下来可以通过 tim 进行事件绑定和构建 IM 应用

更详细的初始化流程请看 SDK 初始化例子

相关资源