抖音开放平台Logo
控制台

SocketTask.close
收藏
我的收藏

基础库 1.0.0 开始支持本方法，这是一个异步方法。

关闭 WebSocket 连接的方法。

前提条件无
业务背景无
使用限制无
注意事项
  • Tip：WebSocket 服务器接口地址必须是 wss 协议，且域名必须是后台配置的合法域名。请参考网络请求。
支持沙盒
否
相关教程无

语法

SocketTask.close(options)

参数说明

options 为 object 类型，属性如下：

属性名类型默认值必填说明最低支持版本
codenumber1000否
关闭连接状态码
1.0.0
reasonstring--否
连接被关闭的原因
1.0.0
successfunction否
接口调用成功的回调函数
1.0.0
failfunction否
接口调用失败的回调函数
1.0.0
completefunction否
接口调用结束的回调函数（调用成功、失败都会执行）
1.0.0

code 参数说明

值

说明

最低支持版本

1000

正常关闭

1.0.0

1001

由于处于后台等异常原因导致的关闭

1.0.0

回调成功

object 类型，属性如下：

属性名类型说明最低支持版本
errMsgstring
"SocketTask.close:ok"
1.0.0

回调失败

object 类型，属性如下：

属性名类型说明最低支持版本
errMsgstring
"SocketTask.close:fail" + 详细错误信息
1.0.0

扫码体验

请使用字节宿主APP扫码

代码示例