bl.connectSocket(Object object)
创建一个 WebSocket 连接。使用前请注意阅读相关说明。
参数
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 |
|---|---|---|---|---|---|
| url | string | 是 | 开发者服务器 wss 接口地址 | ||
| header | Object | 否 | HTTP Header，Header 中不能设置 Referer | ||
| protocols | Array<string> | 否 | 子协议数组 | ||
| success | function | 否 | 接口调用成功的回调函数 | ||
| fail | function | 否 | 接口调用失败的回调函数 | ||
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
返回值
SocketTask
WebSocket 任务
方法
SocketTask.close(function callback)
关闭 WebSocket 连接
SocketTask.onClose(function callback)
监听 WebSocket 连接关闭事件
SocketTask.onError(function callback)
监听 WebSocket 错误事件
SocketTask.onMessage(function callback)
监听 WebSocket 接受到服务器的消息事件
SocketTask.send(function callback)
通过 WebSocket 连接发送数据
示例代码
bl.connectSocket({
url: "wss://example.bilibili.com",
header: {
"content-type": "application/json"
},
protocols: ["protocol1"]
});