Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Timer

计时器功能

Hierarchy

  • App
    • Timer

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns Timer

Properties

Protected _eventEmitter

_eventEmitter: EventEmitter

app 事件总线

Protected name

name: string = 'App'

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

socketIOEvents

socketIOEvents: typeof SocketIOEvents = ...

socket.io 原生事件名称

Accessors

Protected channelInfo

Protected chatInfo

  • 聊天室实例和数据。

    Returns ChatInfo

Protected isTransmitChannel

  • get isTransmitChannel(): boolean

  • 是否为转播主频道

    Returns boolean

Protected socketIOEventsHandlers

Methods

bindSocketIOEvents

  • bindSocketIOEvents(): void

  • 绑定 socket.io 原生事件，

    Returns void

Protected download

  • 下载文件。

    Parameters

    Returns Promise<void>

end

  • end(): Promise<void>

  • 结束计时。

    Returns Promise<void>

Protected formatApiUrl

  • formatApiUrl(path: string): string

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

    Parameters

    • path: string

      以 / 开头的相对路径

    Returns string

Protected formatChatUrl

  • formatChatUrl(path: string): string

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

    Parameters

    • path: string

      以 / 开头的相对路径

    Returns string

Protected formatLiveUrl

  • formatLiveUrl(url: string): string

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

    Parameters

    • url: string

      以 / 开头的相对路径

    Returns string

getTimerStatus

  • 计时过程获取剩余时间等信息。

    Returns Promise<TimerStatus>

    计时器当前状态数据。

Protected handleChatSingnaling

  • handleChatSingnaling(msg: { EVENT: TimerChatEvents }): void

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

    Parameters

    • msg: { EVENT: TimerChatEvents }

      聊天室消息内容。

      • EVENT: TimerChatEvents

    Returns void

off

on

restart

  • restart(): Promise<void>

  • 重新开始倒计时。

    Returns Promise<void>

Protected sendSocket

  • 发送聊天室消息。

    Parameters

    Returns Promise<SocketCallbackParams>

start

  • start(params: { enableTimeOut: boolean; sendTarget: { type: string }[]; time: number }): Promise<void>

  • 开始计时。

    Parameters

    • params: { enableTimeOut: boolean; sendTarget: { type: string }[]; time: number }

      计时选项。

      • enableTimeOut: boolean

        是否可超时

      • sendTarget: { type: string }[]

        选择人群发送。

      • time: number

        总时长，单位：s

    Returns Promise<void>

stop

  • stop(): Promise<void>

  • 暂停计时。

    Returns Promise<void>

Protected trigger

  • 发布事件

    Parameters

    Returns Timer

Generated using TypeDoc