# SocketTask 对象

WebSocket 连接实例 socketTask 有open，close，onOpen，onClose和onMessage方法

# 支持说明

应用能力	Android	iOS	PC	预览效果
小程序	3.19.0	3.19.0	3.21.0	扫码预览用BoosHi扫码或PC端点击
网页应用	X	X	X	/

# SocketTask.send

调用 SocketTask.send(Object object) 通过 WebSocket 连接发送数据。

输入

继承标准对象输入，扩展属性描述：

名称	数据类型	必填	默认值	描述
data	string	是		需要发送的内容。示例值：send text

输出

继承标准对象输出，无扩展属性

# 示例代码

const socketTask = bz.connectSocket({"url":"wss://echo.websocket.org"});
socketTask.onOpen(function(res) {
    console.log(JSON.stringify(res));
    socketTask.send({
      data: "send text",
      success(res) {
        console.log(JSON.stringify(res));
      },
      fail(res) {
        console.log(`send fail: ${JSON.stringify(res)}`);
      }
  });
});

1
2
3
4
5
6
7
8
9
10
11
12
13

# SocketTask.close

调用 SocketTask.close(Object object) 关闭 WebSocket 连接。

输入

继承标准对象输入，扩展属性描述：

名称	数据类型	必填	默认值	描述
code	number	否	1000	关闭连接状态码。示例值：1000
reason	string	否		关闭连接消息。示例值：close socket

输出

继承标准对象输出，无扩展属性

# 示例代码

const socketTask = bz.connectSocket({"url":"wss://echo.websocket.org"});
socketTask.close({
    code: 1000,
    reason: "close socket",
    success(res) {
      console.log(JSON.stringify(res));
    },
    fail(res) {
      console.log(`close fail: ${JSON.stringify(res)}`);
    }
});

1
2
3
4
5
6
7
8
9
10
11

# SocketTask.onOpen

监听 WebSocket 连接打开事件

输入

无

输出

回调函数返回对象的属性：

名称	数据类型	描述
header	object	返回 HTTP Header

# 示例代码

const socketTask = bz.connectSocket({"url":"wss://echo.websocket.org"});
socketTask.onOpen(function(res) {
    console.log(JSON.stringify(res));
});

1
2
3
4

# SocketTask.onClose

监听关闭 WebSocket 连接

输入

无

输出

无

# 示例代码

const socketTask = bz.connectSocket({"url":"wss://echo.websocket.org"});
socketTask.onClose(function(res) {
    console.log(JSON.stringify(res));
});

1
2
3
4

# SocketTask.onMessage

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

输入

无

输出

回调函数返回对象的属性：

名称	数据类型	描述
data	string	服务器返回的消息

# 示例代码

const socketTask = bz.connectSocket({"url":"wss://echo.websocket.org"});
socketTask.onMessage(function(res) {
    console.log(JSON.stringify(res));
});

1
2
3
4

← connectSocket openLocation →