- JS API 列表
- 基础
- 网络
- 媒体
- 地图
- 文件
- 开放接口
- 数据缓存
- 地理位置
- 设备
- 画布
- 界面
- 页面导航
- 侧边栏能力
- 行业开放
- AI/AR能力
- 第三方平台
- TTML
- 转发和挂载
- 其它
- 直播能力
SocketTask.onMessage收藏我的收藏
收藏
我的收藏基础库 1.0.0 开始支持本方法,这是一个同步方法。
监听 WebSocket 接收到服务器发送信息的事件。
前提条件 | 无 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 |
|
支持沙盒 | 否 |
相关教程 | 无 |
语法
SocketTask.onMessage(callback)
参数说明
callback
类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|
function | 是 | 接收到服务器发送信息的事件回调 | 1.0.0 |
callback 是一个回调函数,接收 object 类型的参数,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
protocolType | string | websocket 使用的协议 | 1.0.0 |
data | string | 接收到的服务器消息,类型为 string | arraybuffer | 1.0.0 |
socketType | enum | websocket 类型,"ttnet" | "tradition" | 1.0.0 |
返回值
无