Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Lottery

抽奖功能

Hierarchy

  • App
    • Lottery

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns Lottery

Properties

InLottery

InLottery: InLottery

抽奖状态

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

checkedUserCount

  • checkedUserCount(lotteryRange: string): Promise<number>

  • 检查在线用户人数

    Parameters

    • lotteryRange: string

      类型范围

    Returns Promise<number>

createLottery

  • description:

    创建抽奖

    Parameters

    Returns Promise<{ lotteryId: string }>

Protected download

  • 下载文件。

    Parameters

    Returns Promise<void>

endLottery

  • endLottery(lotteryId: string): Promise<{ preset: string; prize: string }>
  • description:

    结束抽奖 或者 中断倒计时抽奖

    Parameters

    • lotteryId: string

      抽奖id

    Returns Promise<{ preset: string; prize: string }>

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

getCollectInfo

  • getCollectInfo(): Promise<{ file: string; tip: string }[]>
  • description:

    获取中奖人信息收集配置

    Returns Promise<{ file: string; tip: string }[]>

getLotteryStatus

  • getLotteryStatus(): Promise<{ lotteryId?: string; lotteryProcess: string; lotterying?: boolean; winnerList?: { nick: string }[] }>

  • 获取抽奖状态

    Returns Promise<{ lotteryId?: string; lotteryProcess: string; lotterying?: boolean; winnerList?: { nick: string }[] }>

getWinnersList

  • getWinnersList(page: number, lotteryId: string): Promise<winnersList[]>
  • description:

    获取中奖名单

    Parameters

    • page: number

      页数

    • lotteryId: string

      抽奖id

    Returns Promise<winnersList[]>

Protected handleChatSingnaling

  • handleChatSingnaling(msg: { EVENT: keyof LotteryEvents; inLottery?: InLottery; lotteryId: string; prize: string }): void

  • 处理聊天室事件。 监听到聊天室事件后将消息内容传入该方法。

    Parameters

    • msg: { EVENT: keyof LotteryEvents; inLottery?: InLottery; lotteryId: string; prize: string }

      聊天室消息内容。

      • EVENT: keyof LotteryEvents
      • Optional inLottery?: InLottery
      • lotteryId: string
      • prize: string

    Returns void

off

on

resetInLottery

  • resetInLottery(): void
  • description:

    重置抽奖状态

    Returns void

searchLists

  • searchLists(seachUser: string, lotteryRange: string): Promise<searchUserList[]>
  • description:

    搜索名单

    Parameters

    • seachUser: string

      搜索词

    • lotteryRange: string

      抽奖范围类型 all: 全部人 notWinning: 没中奖过的人

    Returns Promise<searchUserList[]>

Protected sendSocket

  • 发送聊天室消息。

    Parameters

    Returns Promise<SocketCallbackParams>

Protected trigger

  • 发布事件

    Parameters

    Returns Lottery

Generated using TypeDoc