• SocketTask.onMessage(CALLBACK)
  • SocketTask.send(OBJECT)
  • SocketTask.close(OBJECT)
  • SocketTask.onOpen(CALLBACK)
  • SocketTask.onClose(CALLBACK)
  • SocketTask.onError(CALLBACK)

    SocketTask 由 uni.connectSocket() 接口创建。

    平台差异说明

    支付宝小程序、头条小程序，没有明确的文档来具体说明这个对象，而是指向了 Web Websocket 对象。

    SocketTask.onMessage(CALLBACK)

    监听 WebSocket 接受到服务器的消息事件

    回调函数

    Function

    WebSocket 接受到服务器的消息事件的回调函数

    回调函数中的参数

    Object

    属性类型说明
    dataString/ArrayBuffer服务器返回的消息

    SocketTask.send(OBJECT)

    通过 WebSocket 连接发送数据

    参数

    属性类型是否必填说明
    dataString/ArrayBuffer是需要发送的内容
    successFunction否接口调用成功的回调函数
    failFunction否接口调用失败的回调函数
    completeFunction否接口调用结束的回调函数（调用成功、失败都会执行）

    SocketTask.close(OBJECT)

    关闭 WebSocket 连接

    参数

    属性类型默认值是否必填说明
    codeNumber1000（表示正常关闭连接）否一个数字值表示关闭连接的状态号，表示连接被关闭的原因。
    reasonString否一个可读的字符串，表示连接被关闭的原因。
    successFunction否接口调用成功的回调函数
    failFunction否接口调用失败的回调函数
    completeFunction否接口调用结束的回调函数（调用成功、失败都会执行）

    SocketTask.onOpen(CALLBACK)

    监听 WebSocket 连接打开事件

    回调函数

    Function

    WebSocket 连接打开事件的回调函数

    回调函数中的参数

    Object

    属性类型说明
    dataString/ArrayBuffer服务器返回的消息

    SocketTask.onClose(CALLBACK)

    监听 WebSocket 连接关闭事件

    回调函数

    Function

    WebSocket 连接关闭事件的回调函数

    SocketTask.onError(CALLBACK)

    监听 WebSocket 错误事件

    回调函数

    Function

    WebSocket 错误事件的回调函数

    回调函数中的参数

    Object

    属性类型说明
    errMsgString错误信息

    发现错误？想参与编辑？在 GitHub 上编辑此页面！