差别
这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录 前一修订版 后一修订版 | 前一修订版 | ||
im:applet:intro [2019/11/28 02:38] lizg [配置服务器域名] |
im:applet:intro [2020/09/27 13:10] (当前版本) allenwang |
||
---|---|---|---|
行 1: | 行 1: | ||
~~NOCACHE~~ | ~~NOCACHE~~ | ||
- | ====== 环信小程序SDK简介 ====== | + | ====== 环信全平台小程序方案简介 ====== |
- | 环信小程序 SDK 为小程序开发提供一套完整的技术解决方案,在微信小程序的开发环境下,集成 IM 相关的功能更加便捷、高效。让您的小程序快速获得安全稳定的 IM 能力,集成简单,使用方便,帮助您快速拓展业务,赢得先机。 | + | 环信小程序 SDK 为各端小程序开发提供一套完整的技术解决方案,在各端小程序的开发环境下,集成 IM 相关的功能更加便捷、高效。让您的小程序快速获得安全稳定的 IM 能力,集成简单,使用方便,帮助您快速拓展业务,赢得先机。 |
+ | **注意:** ''SDK目前支持微信、字节跳动(请使用低于1.70.0以下的版本基础库)、QQ、百度小程序。'' | ||
===== 体验小程序 ===== | ===== 体验小程序 ===== | ||
扫描下方小程序二维码,或者微信搜索**环信即时通讯云**即可快速体验环信小程序 Demo 在线版本 | 扫描下方小程序二维码,或者微信搜索**环信即时通讯云**即可快速体验环信小程序 Demo 在线版本 | ||
{{:im:applet:小程序码.jpg?nolink&600|}} | {{:im:applet:小程序码.jpg?nolink&600|}} | ||
+ | |||
**注意:** | **注意:** | ||
行 13: | 行 15: | ||
* 小程序 Demo 源码可在官网[[http://www.easemob.com/download/im|下载页]] 获取 | * 小程序 Demo 源码可在官网[[http://www.easemob.com/download/im|下载页]] 获取 | ||
+ | |||
+ | * Uni-app Demo Git源码地址 [[https://github.com/easemob/webim-uniapp-demo]] | ||
+ | |||
+ | |||
+ | |||
+ | |||
===== 功能说明 ===== | ===== 功能说明 ===== | ||
- | 环信微信小程序 WebIM 在微信生态系统进行优化,功能与微信对接更为流畅: | + | 环信小程序 WebIM 在微信生态系统进行优化,功能与微信对接更为流畅: |
* 支持账户注册登录 | * 支持账户注册登录 | ||
| | ||
行 23: | 行 31: | ||
| | ||
* 支持个人设置 | * 支持个人设置 | ||
+ | |||
+ | * 支持多人音视频功能(群组中可以进行多人音视频) | ||
+ | |||
===== 开发者集成 ===== | ===== 开发者集成 ===== | ||
行 29: | 行 40: | ||
[[im:quickstart:guide:experience#注册并创建应用|注册并创建应用]] | [[im:quickstart:guide:experience#注册并创建应用|注册并创建应用]] | ||
- | ==== 搭建小程序开发环境 ==== | + | ==== 搭建各端小程序开发环境 ==== |
- | 小程序自己有一个专门的[[https://developers.weixin.qq.com/miniprogram/dev/devtools/devtools.html|微信开发者工具]],[[https://developers.weixin.qq.com/miniprogram/dev/devtools/download.html|最新版本下载地址]]。 | + | 各端小程序自己有一个专门的开发者工具,举例:[[https://developers.weixin.qq.com/miniprogram/dev/devtools/devtools.html|微信开发者工具]],[[https://developers.weixin.qq.com/miniprogram/dev/devtools/download.html|最新版本下载地址]]。 |
按照提示一步步安装好就行,然后用微信扫描二维码登陆。 至此小程序的开发环境差不多完成。 | 按照提示一步步安装好就行,然后用微信扫描二维码登陆。 至此小程序的开发环境差不多完成。 | ||
行 38: | 行 49: | ||
==== 配置服务器域名 ==== | ==== 配置服务器域名 ==== | ||
- | 登录[[https://mp.weixin.qq.com/|微信公众平台]],进入“开发 > 开发设置”页面,配置以下服务器地址: | + | 登录[[https://mp.weixin.qq.com/|微信公众平台]],进入“开发 > 开发设置”页面,配置以下服务器地址(其他平台小程序配置与微信一致): |
- | * request 合法域名, uploadFile 合法域名 | + | <html> |
- | + | <p>request 合法域名,uploadFile 合法域名,downloadFile 合法域名:</p> | |
- | - https://a1.easemob.com | + | <div>1、https://a1.easemob.com</div> |
- | - https://a2.easemob.com | + | <div>2、https://a2.easemob.com</div> |
- | - https://a3.easemob.com | + | <div>3、https://a3.easemob.com</div> |
- | - https://a4.easemob.com | + | <div>4、https://a4.easemob.com</div> |
- | - https://a5.easemob.com | + | <div>5、https://a5.easemob.com</div> |
- | + | ||
- | * socket合法域名 | + | |
- | wss:%%//%%im-api.easemob.com | + | |
- | + | ||
- | + | ||
+ | <p>socket合法域名:</p> | ||
+ | <div>1、wss://im-api.easemob.com(2.0 IM SDK)</div> | ||
+ | <div>2、wss://im-api-wechat.easemob.com(3.0 IM SDK)</div> | ||
+ | </html> | ||
+ | | ||
+ | ==== 各端小程序 WebSocket连接数量 ==== | ||
+ | * QQ、微信小程序: ''**1.7.0**'' 及以上版本,最多可以同时存在 **5** 个 WebSocket 连接 | ||
+ | * 字节小程序: ''**1.0.0**'' 及以上版本 (在当前小程序页面已经有一个WebSocket 连接的情况下,如果再创建一个WebSocket 连接,会重新创建一个 WebSocket 连接,但是之前创建的WebSocket 连接并不会自动关闭。) | ||
+ | * 百度小程序:''**1.9.4**'' 及以上版本,支持存在多个 WebSokcet 连接,每次成功调用会返回一个新的 SocketTask | ||
+ | * 支付宝小程序(暂不支持):支付宝小程序在一段时间内只能保留一个 WebSocket 连接,如果当前已存在 WebSocket 连接,那么会自动关闭该连接,并重新创建一个新的 WebSocket 连接。 | ||
行 68: | 行 83: | ||
* 通过官网[[http://www.easemob.com/download/im|下载SDK]] | * 通过官网[[http://www.easemob.com/download/im|下载SDK]] | ||
| | ||
- | * 从环信的[[https://github.com/easemob/webim-weixin-xcx/releases/tag/v1.2.0|github仓库]] 中获取 SDK 中的文件 | + | * 从环信的[[https://github.com/easemob/webim-weixin-xcx/releases/tag/v3.2.2|github仓库]] 中获取 SDK 中的文件 |
=== 引入SDK === | === 引入SDK === | ||
行 81: | 行 96: | ||
<code javascript> | <code javascript> | ||
//使用示例 | //使用示例 | ||
- | import SDK from "../sdk/connection"; | + | import SDK from "../sdk/connection"; // 2.0sdk |
+ | import SDK from "../sdk/webimSDK3.3.0"; // 3.0sdk | ||
</code> | </code> | ||
=== 实例调用方式 === | === 实例调用方式 === | ||
- | 采用单例模式,所有业务使用唯一实例 | + | 实例化SDK,并挂载在全局对象下 |
<code javascript> | <code javascript> | ||
//实例化SDK对象 | //实例化SDK对象 | ||
- | const WebIM = window.WebIM = SDK; | + | const WebIM = wx.WebIM = SDK; |
WebIM.conn = new WebIM.connection({ | WebIM.conn = new WebIM.connection({ | ||
isMultiLoginSessions: false, //是否可以登录多个网页,并在所有网页上接收消息 | isMultiLoginSessions: false, //是否可以登录多个网页,并在所有网页上接收消息 | ||
https: false, //是否使用HTTPS | https: false, //是否使用HTTPS | ||
- | url: 'wss://im-api.easemob.com/ws/', //XMPP server | + | url: 'wss://im-api-wechat.easemob.com/websocket', // socket server (3.0 SDK) |
- | apiUrl: 'https://a1.easemob.com', | + | apiUrl: 'https://a1.easemob.com', // rest server |
- | isAutoLogin: false, //自动登录 | + | heartBeatWait: 30000, //心跳间隔 |
- | heartBeatWait: 4500, //心跳间隔 | + | |
autoReconnectNumMax: 2, //自动重连次数 | autoReconnectNumMax: 2, //自动重连次数 | ||
- | autoReconnectInterval: 2, //每个重新连接之间的间隔秒, 自动重连次数大于1时有效。 | + | useOwnUploadFun: false // 是否使用自己的上传方式(如将图片文件等上传到自己的服务器,构建消息时只传url) |
}); | }); | ||
</code> | </code> | ||
行 103: | 行 118: | ||
---- | ---- | ||
+ | IM 基本功能和web端一致,请参考web端文档。 | ||
+ | |||
<WRAP group> | <WRAP group> | ||
<WRAP half column> | <WRAP half column> |