# Interface: SocketTask
• SocketTask()
WebSocket 任务，可通过 mogs.connectSocket() 接口创建返回
todo 注意 wx 文档中没有对应的 off 方法，需要验证
# Properties
# close
• close: function
关闭 WebSocket 连接
# Type declaration:
▸ (params?: CloseSocketParams): Promise‹CloseSocketRes›
# 参数:
| 属性 | 类型 |
|---|---|
params? | CloseSocketParams |
CloseSocketParams
| 属性 | 类型 | 描述 |
|---|---|---|
code? | number | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 |
reason? | string | 一个可读的字符串，表示连接被关闭的原因。 这个字符串必须是不长于 123 字节的 UTF-8 文本（不是字符）。 |
complete? | Method | 接口调用结束的回调函数（调用成功、失败都会执行） |
fail? | Method | 接口调用失败的回调函数 |
success? | Method | 接口调用成功的回调函数 |
Returns: function
▸ (params?: CloseSocketParams): Promise‹CloseSocketRes›
# 参数:
| 属性 | 类型 |
|---|---|
params? | CloseSocketParams |
CloseSocketParams
| 属性 | 类型 | 描述 |
|---|---|---|
code? | number | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 |
reason? | string | 一个可读的字符串，表示连接被关闭的原因。 这个字符串必须是不长于 123 字节的 UTF-8 文本（不是字符）。 |
complete? | Method | 接口调用结束的回调函数（调用成功、失败都会执行） |
fail? | Method | 接口调用失败的回调函数 |
success? | Method | 接口调用成功的回调函数 |
# send
• send: function
通过 WebSocket 连接发送数据
# Type declaration:
▸ (params?: SendSocketMessageParams): Promise‹SendSocketMessageRes›
# 参数:
| 属性 | 类型 |
|---|---|
params? | SendSocketMessageParams |
SendSocketMessageParams
| 属性 | 类型 | 描述 |
|---|---|---|
data | string | ArrayBuffer | 需要发送的内容 |
complete? | Method | 接口调用结束的回调函数（调用成功、失败都会执行） |
fail? | Method | 接口调用失败的回调函数 |
success? | Method | 接口调用成功的回调函数 |
Returns: function
▸ (params?: SendSocketMessageParams): Promise‹SendSocketMessageRes›
# 参数:
| 属性 | 类型 |
|---|---|
params? | SendSocketMessageParams |
SendSocketMessageParams
| 属性 | 类型 | 描述 |
|---|---|---|
data | string | ArrayBuffer | 需要发送的内容 |
complete? | Method | 接口调用结束的回调函数（调用成功、失败都会执行） |
fail? | Method | 接口调用失败的回调函数 |
success? | Method | 接口调用成功的回调函数 |
# Methods
# onClose
▸ onClose(callback: OnSocketCloseCallback): void
监听 WebSocket 连接关闭事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | OnSocketCloseCallback |
# 返回值:
void
# onError
▸ onError(callback: OnSocketErrorCallback): void
监听 WebSocket 错误事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | OnSocketErrorCallback |
# 返回值:
void
# onMessage
▸ onMessage(callback: OnSocketMessageCallback): void
监听 WebSocket 接受到服务器的消息事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | OnSocketMessageCallback |
# 返回值:
void
# onOpen
▸ onOpen(callback: OnSocketOpenCallback): void
监听 WebSocket 连接打开事件
# 参数:
| 属性 | 类型 |
|---|---|
callback | OnSocketOpenCallback |
# 返回值:
void