小程序开放平台

文档中心
基础
路由
跳转
转发
界面
网络
发起请求
上传
下载
WebSocket
sendSocketMessage
onSocketOpen
onSocketMessage
onSocketError
onSocketClose
connectSocket
closeSocket
SocketTask
SocketTask事件
支付
数据缓存
媒体
位置
开放接口
设备
XHSML
性能
第三方平台
文件
数据分析
画布

xhs.sendSocketMessage

开发
>
JS API
>
网络
>
WebSocket
>
sendSocketMessage
>
更新时间:2024-11-27 20:12:06

以Promise风格调用: 支持

通过 WebSocket 连接发送数据

参数

Object object

属性
类型
默认值
必填
说明
datastring,arraybuffer需要发送的内容
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性
类型
说明
errMsgstring

xhs.sendSocketMessage(Object object)

参数

Object object

属性
类型
默认值
必填
说明
datastring/ArrayBuffer需要发送的内容
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

示例代码

let socketOpen = false
let socketMsgQueue = []
xhs.connectSocket({
  url: 'test.php'
})

xhs.onSocketOpen(function(res) {
  socketOpen = true
  for (let i = 0; i < socketMsgQueue.length; i++){
    sendSocketMessage(socketMsgQueue[i])
  }
  socketMsgQueue = []
})

function sendSocketMessage(msg) {
  if (socketOpen) {
    xhs.sendSocketMessage({
      data:msg
    })
  } else {
    socketMsgQueue.push(msg)
  }
}