Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Redpacket

Hierarchy

  • App
    • Redpacket

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns Redpacket

Properties

Protected _eventEmitter

_eventEmitter: EventEmitter

app 事件总线

Protected name

name: string = 'App'

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

onlineUserNumber

onlineUserNumber: number = 0

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>

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

getNewest

getPayStatus

  • getPayStatus(logId: string): Promise<PayStatus>

  • 支付状态获取接口

    Parameters

    • logId: string

      支付订单Id

    Returns Promise<PayStatus>

getPreRedPacketList

  • getPreRedPacketList(pageNumber: number): Promise<PreRedPacketList>

  • 获取预设红包列表

    Parameters

    • pageNumber: number

    Returns Promise<PreRedPacketList>

getRedpacketScore

handleChatLogin

  • handleChatLogin(msg: { onlineUserNumber: number }): void

  • 设置在线人数

    Parameters

    • msg: { onlineUserNumber: number }
      • onlineUserNumber: number

    Returns void

Protected handleChatSingnaling

  • handleChatSingnaling(msg: { EVENT: RedpacketChatEvents; delayTime: number; onlineUserNumber: number; type: string }): void

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

    Parameters

    • msg: { EVENT: RedpacketChatEvents; delayTime: number; onlineUserNumber: number; type: string }

      聊天室消息内容。

      • EVENT: RedpacketChatEvents
      • delayTime: number

        红包倒计时

      • onlineUserNumber: number

        在线人数

      • type: string

        红包类型

    Returns void

handleRedpacketDelayStart

  • handleRedpacketDelayStart(msg: { delayTime: number; type: redpacketType }): Promise<void>

  • 定时红包开始

    Parameters

    Returns Promise<void>

off

  • off(eventName: string, listener: Callback<undefined | Record<string, unknown>>): Redpacket

  • 取消订阅事件

    Parameters

    • eventName: string

      事件名称

    • listener: Callback<undefined | Record<string, unknown>>

      事件处理器

    Returns Redpacket

on

  • on(eventName: string, listener: Callback<undefined | Record<string, unknown>>): Redpacket

  • 订阅事件

    Parameters

    • eventName: string

      事件名称

    • listener: Callback<undefined | Record<string, unknown>>

      事件处理器

    Returns Redpacket

sendPreRedpacket

  • sendPreRedpacket(redpackPresetId: string): Promise<void>

  • 发送预设红包

    Parameters

    • redpackPresetId: string

      预设红包id

    Returns Promise<void>

sendRP

Protected sendSocket

  • 发送聊天室消息。

    Parameters

    Returns Promise<SocketCallbackParams>

setCurrentWindow

  • setCurrentWindow(currentWindow: string): void

  • 设置当前环境，区分网页端和客户端的api

    Parameters

    • currentWindow: string

    Returns void

Protected trigger

  • 发布事件

    Parameters

    Returns Redpacket

Generated using TypeDoc