Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update web & miniprogram github repositories #1296

Merged
merged 2 commits into from
Dec 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion MiniProgram/IMSDK/tim-wx-friendship.js

This file was deleted.

1 change: 0 additions & 1 deletion MiniProgram/IMSDK/tim-wx.js

This file was deleted.

113 changes: 16 additions & 97 deletions MiniProgram/README.md
Original file line number Diff line number Diff line change
@@ -1,104 +1,23 @@
### 项目简介
**TIMSDK MiniProgram 及 其相关配套 UI 组件库 chat-uikit-wechat 已完成仓库迁移,请移步至最新仓库地址 [**chat-uikit-wechat**](https://github.com/TencentCloud/chat-uikit-wechat) 进行体验。**

TUIKit 基于小程序原生开发,我们提供了 IM 聊天、在线客服、实时音视频通话等开源组件,开发者可以在这些组件的基础上灵活自定义修改。
## 关于腾讯云即时通信 IM

### 效果展示
腾讯云即时通信(Instant Messaging,IM)基于 QQ 底层 IM 能力开发,仅需植入 SDK 即可轻松集成聊天、会话、群组、资料管理能力,帮助您实现文字、图片、短语音、短视频等富媒体消息收发,全面满足通信需要。

![](https://web.sdk.qcloud.com/component/TUIKit/assets/tuikit-github-1.jpg)

### 一分钟跑通 TUIKit
## 关于 chat-uikit-wechat

#### 步骤1:克隆仓库到本地
chat-uikit-wechat 是基于腾讯云 IM SDK 的一款 小程序 UI 组件库,它提供了一些通用的 UI 组件,包含会话、聊天、群组、音视频通话等功能。基于 UI 组件您可以像搭积木一样快速搭建起自己的业务逻辑。
chat-uikit-wechat 中的组件在实现 UI 功能的同时,会调用 IM SDK 相应的接口实现 IM 相关逻辑和数据的处理,因而开发者在使用 chat-uikit-wechat 时只需关注自身业务或个性化扩展即可。
chat-uikit-wechat 效果如下图所示:
<img width="1015" src="https://user-images.githubusercontent.com/40623255/202661227-d4227dcc-bada-42a6-a57b-0d0c0abc098b.png"/>

```javascript
### 相关链接
- github 仓库地址(含 UI ):[**chat-uikit-wechat**](https://github.com/TencentCloud/chat-uikit-wechat)
- npm 仓库地址(含 UI ):[**@tencentcloud/chat-uikit-wechat**](https://www.npmjs.com/package/@tencentcloud/chat-uikit-wechat)
- npm 仓库地址(无 UI ):[**tim-js-sdk**](https://www.npmjs.com/package/tim-js-sdk)

# 命令行执行
git clone https://github.com/tencentyun/TIMSDK.git

# 进入小程序 TUIKit 项目
cd TIMSDK/MiniProgram/TUIKit

```

#### 步骤2:安装微信小程序 [开发者工具](https://mp.weixin.qq.com/debug/wxadoc/dev/devtools/download.html)。

#### 步骤3:使用微信开发者工具导入项目,然后填入自己的小程序 AppID。

>!即时通信 IM 属于增值服务,详细计费规则请参见 [即时通信 IM 价格说明](https://cloud.tencent.com/document/product/269/11673)。实时通话需要提前开通腾讯云 [实时音视频 TRTC](https://cloud.tencent.com/document/product/647/16788)。


#### 步骤4:配置 TUIKit 工程文件,填入您的应用信息

1. 找到并打开 `TUIKit/miniprogram/debug/GenerateTestUserSig.js` 文件。
2. 设置 `GenerateTestUserSig.js` 文件中的相关参数:
<ul><li>SDKAPPID:默认为0,请设置为实际的 SDKAppID。</li>
<li>SECRETKEY:默认为空字符串,请设置为实际的密钥信息。</li></ul>
<img src="https://main.qcloudimg.com/raw/575902219de19b4f2d4595673fa755d4.png">

>!
>- 本文提到的生成 UserSig 的方案是在客户端代码中配置 SECRETKEY,该方法中 SECRETKEY 很容易被反编译逆向破解,一旦您的密钥泄露,攻击者就可以盗用您的腾讯云流量,因此**该方法仅适合本地跑通 TUIKit 和功能调试**。
>- 正确的 UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端,并提供面向 App 的接口,在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig。更多详情请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/647/17275#Server)。

#### 步骤5:编译运行
1. 打开微信开发者工具,选择【小程序】,单击新建图标,选择【导入项目】。
2. 填写您微信小程序的 AppID,单击【导入】。

![](https://web.sdk.qcloud.com/component/TUIKit/assets/tuikit-github-2.jpg)

>!此处应输入您微信小程序的 AppID,而非 SDKAppID。
3. 单击【预览】,生成二维码,通过手机微信扫码二维码即可进入小程序。

![](https://web.sdk.qcloud.com/component/TUIKit/assets/tuikit-github-3.jpg)

### 常见问题

**1. 小程序如果需要上线或者部署正式环境怎么办?**
请在**微信公众平台**>**开发**>**开发设置**>**服务器域名**中进行域名配置:

将以下域名添加到 **request 合法域名**:

**1. 小程序如果需要上线或者部署正式环境怎么办?**
请在**微信公众平台**>**开发**>**开发管理**>**开发设置**>**服务器域名**中进行域名配置:

从v2.11.2起 SDK 支持了 WebSocket,WebSocket 版本须添加以下域名到 **socket 合法域名**:

| 域名 | 说明 | 是否必须 |
|:-------:|---------|----|
|`wss://wss.im.qcloud.com`| Web IM 业务域名 | 必须|
|`wss://wss.tim.qq.com`| Web IM 业务域名 | 必须|

将以下域名添加到 **request 合法域名**:

| 域名 | 说明 | 是否必须 |
|:-------:|---------|----|
|`https://web.sdk.qcloud.com`| Web IM 业务域名 | 必须|
|`https://webim.tim.qq.com` | Web IM 业务域名 | 必须|
|`https://api.im.qcloud.com` | Web IM 业务域名 | 必须|
|`https://aegis.qq.com`| Web IM 统计域名 | 必须 |

v2.10.2及以下版本使用 HTTP,HTTP 版本须添加以下域名到 **request 合法域名**:

| 域名 | 说明 | 是否必须 |
|:-------:|---------|----|
|`https://webim.tim.qq.com` | Web IM 业务域名 | 必须|
|`https://yun.tim.qq.com` | Web IM 业务域名 | 必须|
|`https://events.tim.qq.com` | Web IM 业务域名 | 必须|
|`https://grouptalk.c2c.qq.com`| Web IM 业务域名 | 必须|
|`https://pingtas.qq.com` | Web IM 统计域名 | 必须|

将以下域名添加到 **uploadFile 合法域名**:

| 域名 | 说明 | 是否必须 |
|:-------:|---------|----|
|`https://cos.ap-shanghai.myqcloud.com` | 文件上传域名 | 必须|

将以下域名添加到 **downloadFile 合法域名**:

| 域名 | 说明 | 是否必须 |
|:-------:|---------|----|
|`https://cos.ap-shanghai.myqcloud.com` | 文件下载域名 | 必须|


### 文档:
- SDK API 手册:https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html
- SDK 更新日志:https://cloud.tencent.com/document/product/269/38492
### 文档
- [快速入门(小程序)](https://cloud.tencent.com/document/product/269/68376)
- [SDK API 手册](https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html)
- [SDK 更新日志](https://cloud.tencent.com/document/product/269/38492)
81 changes: 0 additions & 81 deletions MiniProgram/TUIKit/README.md

This file was deleted.

This file was deleted.

This file was deleted.

Loading