Class ChatChannel

私聊频道

Hierarchy

WsEventBase<IChatEvents>
- ChatChannel

Index

Constructors

Properties

emitter rwsOptions ws

Methods

addListener clearListener close connect get markRead off on once reconnect removeListener send setToken

Constructors

constructor

new ChatChannel(user: string, apiKey: string): ChatChannel
实例化私聊频道
Parameters
- user: string
  目标用户名
- apiKey: string
  接口 API Key
Returns ChatChannel
Overrides WsEventBase<IChatEvents>.constructor
- Defined in chat.ts:40

Properties

emitter

emitter: BrowserEventEmitter = ...

事件触发器

rwsOptions

rwsOptions: Options = ...

WebSocket 配置

ws

ws: ReconnectingWebSocket | null = null

WebSocket 连接对象

Methods

addListener

addListener<K extends keyof IChatEvents>(
event: K,
listener: IChatEvents[K],
): BrowserEventEmitter
添加 WebSocket 消息监听函数
Type Parameters
- K extends keyof IChatEvents
Parameters
- event: K
  WebSocket 事件
- listener: IChatEvents[K]
  监听器
Returns BrowserEventEmitter
Inherited from WsEventBase.addListener
- Defined in ws.ts:131

clearListener

clearListener(event?: keyof IChatEvents): void
清除 WebSocket 监听
Parameters
- Optionalevent: keyof IChatEvents
Returns void
Inherited from WsEventBase.clearListener
- Defined in ws.ts:113

close

close(): void
关闭私聊频道

Returns void
- Defined in chat.ts:109

connect

connect(reload?: boolean): Promise<ReconnectingWebSocket>
连接用户私聊频道
Parameters
- reload: boolean = false
Returns Promise<ReconnectingWebSocket>
Websocket 连接对象
Overrides WsEventBase.connect
- Defined in chat.ts:59

get

get(param: IChatQuery): Promise<IChatData[]>
获取用户私聊历史消息
Parameters
- param: IChatQuery
  消息参数
Returns Promise<IChatData[]>
私聊消息列表
- Defined in chat.ts:118

markRead

markRead(): Promise<void>
标记用户消息已读

Returns Promise<void>
执行结果
- Defined in chat.ts:140

off

off<K extends keyof IChatEvents>(
event?: K,
listener?: IChatEvents[K],
): BrowserEventEmitter
移除 WebSocket 监听
Type Parameters
- K extends keyof IChatEvents
Parameters
- Optionalevent: K
  WebSocket 事件
- Optionallistener: IChatEvents[K]
  监听器
Returns BrowserEventEmitter
EventEmitter
Inherited from WsEventBase.off
- Defined in ws.ts:94

on

on<K extends keyof IChatEvents>(
event: K,
listener: IChatEvents[K],
): BrowserEventEmitter
WebSocket 监听
Type Parameters
- K extends keyof IChatEvents
Parameters
- event: K
  WebSocket 事件
- listener: IChatEvents[K]
  监听器
Returns BrowserEventEmitter
EventEmitter
Inherited from WsEventBase.on
- Defined in ws.ts:81

once

once<K extends keyof IChatEvents>(
event: K,
listener: IChatEvents[K],
): BrowserEventEmitter
WebSocket 单次监听
Type Parameters
- K extends keyof IChatEvents
Parameters
- event: K
  WebSocket 事件
- listener: IChatEvents[K]
  监听器
Returns BrowserEventEmitter
EventEmitter
Inherited from WsEventBase.once
- Defined in ws.ts:106

reconnect

reconnect(): Promise<unknown>
重连通知频道

Returns Promise<unknown>
Websocket 连接对象
Inherited from WsEventBase.reconnect
- Defined in ws.ts:52

removeListener

removeListener<K extends keyof IChatEvents>(
event: K,
listener: IChatEvents[K],
): BrowserEventEmitter
移除 WebSocket 消息监听函数
Type Parameters
- K extends keyof IChatEvents
Parameters
- event: K
  WebSocket 事件
- listener: IChatEvents[K]
  监听器
Returns BrowserEventEmitter
Inherited from WsEventBase.removeListener
- Defined in ws.ts:122

send

send(msg: string): Promise<void>
发送私聊消息
Parameters
- msg: string
  消息内容
Returns Promise<void>
void
- Defined in chat.ts:99

setToken

setToken(apiKey: string): void
重新设置请求 Token
Parameters
- apiKey: string
  接口 API Key
Returns void
- Defined in chat.ts:50