Class WeChatWebSocket

对SocketTask的封装，提供标准的WebSocket接口

Hierarchy

WeChatWebSocket

Index

Constructors

constructor

Events

Properties

socketTask

Accessors

readyState

Methods

close
send

Constructors

constructor

new WeChatWebSocket(socketTask: any): WeChatWebSocket

Parameters
- socketTask: any
Returns WeChatWebSocket

Events

onclose

onclose(result: WeChatWebSocketCloseResult): void

WebSocket连接关闭的回调

Parameters
- result: WeChatWebSocketCloseResult
Returns void

onerror

onerror(result: WeChatWebSocketErrorResult): void

WebSocket的错误事件

Parameters
- result: WeChatWebSocketErrorResult
Returns void

onmessage

onmessage(result: WeChatWebSocketMessageResult): void

WebSocket的接收到消息的通知事件

Parameters
- result: WeChatWebSocketMessageResult
Returns void

onopen

onopen(result: WeChatWebSocketOpenResult): void

WebSocket连接打开的回调，详见SocketTask.onOpen

Parameters
- result: WeChatWebSocketOpenResult
Returns void

Properties

socketTask

socketTask: SocketTask

Accessors

readyState

get readyState(): any

Returns any

Methods

close

close(code?: number, reason?: string): Promise<any>

关闭 WebSocket 连接

Parameters
- Default value code: number = 1000
  
  1000(表示正常关闭连接), 一个数字值表示关闭连接的状态号, 表示连接被关闭的原因.
- Default value reason: string = "正常关闭"
  
  一个可读的字符串, 表示连接被关闭的原因, 这个字符串必须是不长于 123 字节的 UTF-8 文本(不是字符)。
Returns Promise<any>

send

send(data: string | ArrayBuffer): Promise<any>

通过 WebSocket 连接发送数据

Parameters
- data: string | ArrayBuffer
Returns Promise<any>

Generated using TypeDoc