Class Notice

摸鱼派通知接口

Hierarchy

WsEventBase<INoticeEvents>
- Notice

Index

Constructors

Properties

emitter rwsOptions ws

Methods

addListener clearListener connect count list makeRead off on once readAll reconnect removeListener setToken

Constructors

constructor

new Notice(token?: string): Notice
实例化通知
Parameters
- token: string = ''
  认证 Token
Returns Notice
Overrides WsEventBase<INoticeEvents>.constructor
- Defined in notice.ts:58

Properties

emitter

emitter: BrowserEventEmitter = ...

事件触发器

rwsOptions

rwsOptions: Options = ...

WebSocket 配置

ws

ws: ReconnectingWebSocket | null = null

WebSocket 连接对象

Methods

addListener

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

clearListener

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

connect

connect(reload?: boolean): Promise<ReconnectingWebSocket>
连接通知频道
Parameters
- reload: boolean = false
  是否重新连接
Returns Promise<ReconnectingWebSocket>
Websocket 连接对象
Overrides WsEventBase.connect
- Defined in notice.ts:172

count

count(): Promise<INoticeCount>
获取未读消息数

Returns Promise<INoticeCount>
未读消息数信息
- Defined in notice.ts:78

list

list(type: NoticeType): Promise<NoticeList>
获取消息列表
Parameters
- type: NoticeType
  消息类型
Returns Promise<NoticeList>
消息列表
- Defined in notice.ts:99

makeRead

makeRead(type: NoticeType): Promise<void>
已读指定类型消息
Parameters
- type: NoticeType
  消息类型
Returns Promise<void>
- Defined in notice.ts:123

off

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

on

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

once

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

readAll

readAll(): Promise<void>
已读所有消息

Returns Promise<void>
- Defined in notice.ts:139

reconnect

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

Returns Promise<unknown>
Websocket 连接对象
Overrides WsEventBase.reconnect
- Defined in notice.ts:156

removeListener

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

setToken

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