tt.connectSocket
收藏我的收藏
基础库 1.0.0 开始支持本方法,这是一个异步方法。
创建一个 WebSocket 连接实例,并通过返回的socketTask操作该连接。网络相关的 API 在使用前需要配置域名白名单。请参考网络请求。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 |
|
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.connectSocket(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| url | string | 是 | Socket 连接地址 | 1.0.0 | |
| header | object | 否 | HTTP Header | 1.0.0 | |
| protocols | Array<string> | null | 否 | 子协议数组 | 1.0.0 |
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.0.0 |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| socketTaskId | number | 当前创建的 sockTask 的序号 | 1.0.0 |
| errMsg | string | "connectSocket:ok" | 1.0.0 |
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "connectSocket:fail" + 详细错误信息 | 1.0.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 123594 | connectSocket:fail app in background | U | 后台时调用导致 避免在后台时调用 | 1.0.0 |
| 123501 | connectSocket:fail url not in domain list | D | 不在白名单域名 请在控制台配置 | 1.0.0 |
| 123503 | connectSocket:fail can only open 5 socket | D | socket数量限制 5个以内 socket 数量管理 | 1.0.0 |
| 123599 | connectSocket:fail params.url should match pattern | D | 参数校验未通过 | 1.0.0 |
扫码体验
请使用字节宿主APP扫码
