小程序/小玩法/直播互动工具使用云托管webSocket
收藏
我的收藏介绍
开发者可在小程序,小玩法,直播互动工具里面使用相关webSocket API,监听服务端相关推送事件。
操作指引
- 1.通过createCloud 创建客户端云托管实例。
const cloud = tt.createCloud({ envID: 'env-0WIYiY4PNP' });
- 2.通过connectContainer 创建 webSocket 连接实例,必须传入开发者服务接口地址。
const webSocket = cloud.connectContainer({ path: "/path" });
- 3.通过 webSocket 实例来监听服务端推送的数据或者向服务端推送数据。
webSocket.onMessage((message) => { // 每次 WebSocket 发送的信息 console.log("socket message:", message); });
注意事项
最多可以同时存在 5 个 WebSocket 连接。connectContainer 返回成功只代表连接任务创建成功,真正连接服务器成功需要监听onOpen回调。退后台5s后websocket会自动断连。
tt.createCloud
基础库 2.70.0 开始支持本方法,这是一个同步方法
返回一个Cloud云调用实例
语法
tt.createCloud(options)
参数说明
options 为object类型,属性如下:
参数 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
envID | string | - | 是 | 云环境ID | 小程序最低基础库版本为2.70.0 直播互动工具最低基础库版本为3.48.0.0 |
serviceID | string | - | 否 | 云服务ID | 小程序最低基础库版本为2.70.0 直播互动工具最低基础库版本为3.48.0.0 |
返回值
Cloud实例
Cloud
通过
tt.createCloud
获取的实例,通过它访问云托管服务。方法
方法名 | 最低支持版本 |
callContainer | 小程序最低基础库版本为2.70.0 直播互动工具最低基础库版本为3.48.0.0 |
CloudID | 小程序最低基础库版本为2.70.0 直播互动工具最低基础库版本为3.48.0.0 |
uploadFile | 小程序最低基础库版本为2.76.0 |
downLoadFile | 小程序最低基础库版本为2.76.0 |
deleteFile | 小程序最低基础库版本为2.76.0 |
getTempFileURL | 小程序最低基础库版本为2.76.0 |
connectContainer | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
Cloud.connectContainer
小程序基础库2.78.0开始支持本方法,直播互动工具最低基础库版本为3.48.0.0,这是一个异步方法
创建一个 抖音云托管的WebSocket 连接实例,并通过返回的 CloudSocketTask 操作该连接。
语法
Cloud.connectContainer(options);
参数说明
options 为 object 类型,属性如下:
参数 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
path | string | | 是 | 开发者服务接口地址 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
serviceID | string | | 否 | 云服务id。若不传以tt.createCloud传入的服务id为准,至少需要一个有效serviceID | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
header | object | | 否 | HTTP Header | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
success | function | | 否 | 接口调用成功后的回调函数 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
fail | function | | 否 | 接口调用失败后的回调函数 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
complete | function | | 否 | 接口调用结束后的回调函数(调用成功、失败都会执行) | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
回调成功
属性名 | 类型 | 说明 | 最低支持版 本 |
errMsg | string | "connectContainer:ok" | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
socketTaskId | number | 任务id | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
回调失败
参数为 Object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
errMsg | string | "connectContainer:fail " + 详细错误信息 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
errNo | number | 错误码 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
返回值
CloudSocketTask实例
CloudSocketTask
基础库2.78.0开始支持本类型实例
通过
Cloud.connectContainer
获取的 WebSocket 任务实例属性
只读属性
属性 | 类型/常量 | 说明 | 最低支持版本 |
readyState | number | undefined | 表示 Socket 连接状态 code; 若由于参数错误导致未创建连接, 则为 undefined | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
CloudSocketTask.CONNECTING | 0 | 表示 Socket 正在连接 | 小程 序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
CloudSocketTask.OPEN | 1 | 表示 Socket 连接已经打开 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
CloudSocketTask.CLOSING | 2 | 表示 Socket 连接关闭中 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
CloudSocketTask.CLOSED | 3 | 表示 Socket 连接已关闭 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
方法
方法名 | 说明 | 最低支持版本 |
send | 通过 WebSocket 连接发送数据 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
close | 关闭 WebSocket 连接 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
onOpen | 监听 WebSocket 连接服务器成功的事件 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
onClose | 监听 WebSocket 与服务器的连接断开的事件 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
onMessage | 监听 WebSocket 接收到服务器发送信息的事件 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
onError | 监听 WebSocket 发生错误的事件 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
getExtensionManager | 获取扩展接口管理器 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
CloudSocketTask.send
基础库2.78.0开始支持本方法,这是一个异步方法
通过 WebSocket 连接向服务端发送数据
语法
CloudSocketTask.send(options);
参数说明
options 为 object 类型,属性如下:
参数 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
data | string/arraybuffer | | 是 | 数据内容 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
success | function | | 否 | 接口调用成功后的回调函数 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
fail | function | | 否 | 接口调用失败后的回调函数 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
complete | function | | 否 | 接口调用结束后 的回调函数(调用成功、失败都会执行) | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
回调成功
属性名 | 类型 | 说明 | 最低支持版本 |
errMsg | string | "CloudSocketTask.send:ok" | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
回调失败
属性名 | 类型 | 说明 | 最低支持版本 |
errMsg | string | "CloudSocketTask.send:fail " + 详细错误信息 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
errNo | number | 错误码 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
返回值
无
CloudSocketTask.close
基础库2.78.0开始支 持本方法,这是一个异步方法
关闭 WebSocket 连接
语法
CloudSocketTask.close(options);
参数说明
options 为 object 类型,属性如下:
参数 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
code | number | 1000 | 否 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 | |
reason | string | normal close | 否 | 连接被关闭的原因 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
success | function | | 否 | 接口调用成功后的回调函数 | 小程序最低基础库版本为2.78.0 直播互动工具最低基础库版本为3.48.0.0 |
fail | function | |