my.closesocket(object object)
主体: 企业支付宝小程序 、 个人支付宝小程序
关闭 websocket 连接。
object object
查看示例
属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |
---|---|---|---|---|---|
code | number | 1000 | 否 | 基础库: 1.0/2.3.1 支付宝: 10.3.80 ide: 3.8.0 |
连接被关闭的状态码。只能传 1000、或 3000~4999 之间 |
reason | string | - | 否 | 基础库: 1.0/2.3.1 支付宝: 10.3.80 ide: 3.8.0 |
连接被关闭的原因 |
success | function | - | 否 | - | 调用成功的回调函数 |
fail | function | - | 否 | - | 调用失败的回调函数 |
complete | function | - | 否 | - | 调用结束的回调函数(调用成功、失败都会执行) |
success 回调函数
参数
object res
属性 | 类型 | 描述 |
---|---|---|
message | string | 消息内容 |
fail 回调的参数为 object,error
属性为错误码,errormessage
属性为错误消息。
错误码 | 错误消息 | 凯发app官方网站的解决方案 |
---|---|---|
2 | 参数非法 | 请检查参数类型是否正确 |
code 只能为 1000,或在 3000~4999 之间 | 请修改 code 到合法区间 |
代码示例
// 使用 onsocketclose 监听
my.onsocketclose(function(res) {
console.log('socket 连接已关闭!')
});
// 关闭 socket 连接
my.closesocket({
success:()=>{
console.log('关闭成功');
}
})