Class Notice

实现公告功能：

获取房间公告内容。
发布公告。
移除公告。

Hierarchy

App
- Notice

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Notice(): Notice

Inherited from App.constructor

Returns Notice

Properties

Protected _eventEmitter

_eventEmitter: EventEmitter

app 事件总线

Protected name

name: string = 'App'

互动功能名称。用于公共方法中区分不同的互动功能。

socketIOEvents

socketIOEvents: typeof SocketIOEvents = ...

socket.io 原生事件名称

Accessors

Protected channelInfo

get channelInfo(): ChannelInfo

频道信息

Returns ChannelInfo

Protected chatInfo

get chatInfo(): ChatInfo

聊天室实例和数据。

Returns ChatInfo

Protected isTransmitChannel

get isTransmitChannel(): boolean

是否为转播主频道

Returns boolean

Protected socketIOEventsHandlers

get socketIOEventsHandlers(): CustomEventHandlers

Returns CustomEventHandlers

Methods

bindSocketIOEvents

bindSocketIOEvents(): void

Inherited from App.bindSocketIOEvents

绑定 socket.io 原生事件，

Returns void

Protected download

download(url: string, params?: UniversalParams): Promise<void>

Inherited from App.download

下载文件。

Parameters
- url: string
  
  下载路径。
- Optional params: UniversalParams
  
  参数。
Returns Promise<void>

Protected formatApiUrl

formatApiUrl(path: string): string

Inherited from App.formatApiUrl

返回完整的 url 地址（api 域名相关）

Parameters
- path: string
  
  以 / 开头的相对路径
Returns string

Protected formatChatUrl

formatChatUrl(path: string): string

Inherited from App.formatChatUrl

返回完整的 url 地址（chat 域名相关）

Parameters
- path: string
  
  以 / 开头的相对路径
Returns string

Protected formatLiveUrl

formatLiveUrl(url: string): string

Inherited from App.formatLiveUrl

返回完整的 url 地址（live 域名相关）

Parameters
- url: string
  
  以 / 开头的相对路径
Returns string

getCurrentNotice

getCurrentNotice(): Promise<string>

获取房间公告内容。

Returns Promise<string>

房间公告内容。

Protected handleChatSingnaling

handleChatSingnaling(msg: { EVENT: NoticeChatEvents }): void

Overrides App.handleChatSingnaling

处理聊天室事件。监听到聊天室事件后将消息内容传入该方法，将会触发对应的事件（需要使用 Notice.on 进行监听）。

Parameters
- msg: { EVENT: NoticeChatEvents }
  
  聊天室消息内容。
  - EVENT: NoticeChatEvents
Returns void

off

off<K>(eventName: K, listener: Callback<NoticeEventMap[K]>): Notice

Overrides App.off

取消订阅事件

Type parameters
- K: keyof NoticeEventMap
Parameters
- eventName: K
  
  事件名称
- listener: Callback<NoticeEventMap[K]>
  
  事件处理器
Returns Notice

on

on<K>(eventName: K, listener: Callback<NoticeEventMap[K]>): Notice

Overrides App.on

订阅事件。

Type parameters
- K: keyof NoticeEventMap
Parameters
- eventName: K
  
  事件名称
- listener: Callback<NoticeEventMap[K]>
  
  事件处理器
Returns Notice

publishNotice

publishNotice(content: string): Promise<void>

发布公告。

Parameters
- content: string
  
  公告内容。
Returns Promise<void>

Protected sendSocket

sendSocket(message: UniversalParams, eventName?: string): Promise<SocketCallbackParams>

Inherited from App.sendSocket

发送聊天室消息。

Parameters
- message: UniversalParams
  
  消息内容。
- eventName: string = 'message'
Returns Promise<SocketCallbackParams>

Protected trigger

trigger(eventName: string, data?: UniversalParams): Notice

Inherited from App.trigger

发布事件

Parameters
- eventName: string
  
  事件名称
- Optional data: UniversalParams
Returns Notice

unpublishNotice

unpublishNotice(): Promise<void>

移除公告。

Returns Promise<void>

Generated using TypeDoc