SocketTask.close
收藏我的收藏
收藏基础库 1.0.0 开始支持本方法，这是一个异步方法。
关闭 WebSocket 连接的方法。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 |
|
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
SocketTask.close(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| code | number | 1000 | 否 | 关闭连接状态码 | 1.0.0 |
| reason | string | -- | 否 | 连接被关闭的原因 | 1.0.0 |
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.0.0 |
code 参数说明
值 | 说明 | 最低支持版本 |
1000 | 正常关闭 | 1.0.0 |
1001 | 由于处于后台等异常原因导致的关闭 | 1.0.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "SocketTask.close:ok" | 1.0.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "SocketTask.close:fail" + 详细错误信息 | 1.0.0 |
扫码体验
请使用字节宿主APP扫码
