Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CheckIn

签到功能

Hierarchy

  • App
    • CheckIn

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns CheckIn

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>

downloadCheckInDetail

  • downloadCheckInDetail(params: { checkInId: string; checkInTime: number }): Promise<void>

  • 下载签到详情文件。

    Parameters

    • params: { checkInId: string; checkInTime: number }
      • checkInId: string

        签到 id。

      • checkInTime: number

        签到记录创建时间，格式为YYYY-MM-DD HH:MM:SS 。在接口 CheckIn.getCheckInDetail 有返回该信息。

    Returns Promise<void>

downloadCheckInHistory

  • downloadCheckInHistory(params: { endDate: string; startDate: string }): Promise<void>

  • 下载历史签到列表。

    Parameters

    • params: { endDate: string; startDate: string }
      • endDate: string

        结束日期，格式为YYYY-MM-DD

      • startDate: string

        开始日期，格式为YYYY-MM-DD

    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

getCheckInDetail

  • getCheckInDetail(params: { checkInId: string; page?: number; pageSize?: number }): Promise<CheckInDetail>

  • 获取签到详情。

    Parameters

    • params: { checkInId: string; page?: number; pageSize?: number }
      • checkInId: string
      • Optional page?: number
      • Optional pageSize?: number

    Returns Promise<CheckInDetail>

    签到详情。

getCheckInHistory

  • getCheckInHistory(params: { endDate: string; startDate: string }): Promise<CheckInHistoryDetail[]>

  • 获取历史签到列表数据。

    Parameters

    • params: { endDate: string; startDate: string }
      • endDate: string

        结束日期，格式为YYYY-MM-DD

      • startDate: string

        开始日期，格式为YYYY-MM-DD

    Returns Promise<CheckInHistoryDetail[]>

    历史签到列表。

getCheckInNum

  • getCheckInNum(): Promise<number>

  • 实时获取签到人数。

    description

    可每隔 1s 调用一次。

    Returns Promise<number>

    签到人数。

getCheckInStatus

  • 获取签到状态及签到文案、剩余时间、总时长等。

    Returns Promise<CheckInStatus>

    当前签到状态及签到文案、剩余时间、总时长等。

Protected handleChatSingnaling

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

  • 处理聊天室事件。

    description

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

    Parameters

    • msg: { EVENT: CheckInChatEvents }

      聊天室消息内容。

      • EVENT: CheckInChatEvents

    Returns void

off

on

sendResult

  • sendResult(checkinId: string): Promise<void>

  • 发送结果。

    description

    发送签到 id，提示特殊角色（讲师/嘉宾/助教/管理员）用户显示签到结果弹窗，特殊角色会被触发 'show-result' 事件。

    Parameters

    • checkinId: string

      签到 id。

    Returns Promise<void>

Protected sendSocket

  • 发送聊天室消息。

    Parameters

    Returns Promise<SocketCallbackParams>

start

  • start(startData: { duration: number; sendTarget: { type: string }[]; tips: string }): Promise<void>

  • 发起签到。

    Parameters

    • startData: { duration: number; sendTarget: { type: string }[]; tips: string }
      • duration: number

        签到时长。单位：秒。

      • sendTarget: { type: string }[]

        选择人群发送。

      • tips: string

        签到文案

    Returns Promise<void>

stop

  • stop(): Promise<void>

  • 停止签到。

    Returns Promise<void>

Protected trigger

  • 发布事件

    Parameters

    Returns CheckIn

Generated using TypeDoc