Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PushCard

Hierarchy

  • App
    • PushCard

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns PushCard

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>

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

getList

  • getList(): Promise<any>

  • 获取卡片列表

    Returns Promise<any>

Protected handleChatSingnaling

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

  • Parameters

    • msg: { EVENT: ChatEvents }
      • EVENT: ChatEvents

    Returns void

off

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

  • 取消订阅事件

    Parameters

    • eventName: string

      事件名称

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

      事件处理器

    Returns PushCard

on

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

  • 订阅事件

    Parameters

    • eventName: string

      事件名称

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

      事件处理器

    Returns PushCard

pushCard

  • pushCard(id: string): Promise<any>

  • 推送卡片

    Parameters

    • id: string

      卡片id

    Returns Promise<any>

Protected sendSocket

  • 发送聊天室消息。

    Parameters

    Returns Promise<SocketCallbackParams>

stopCard

  • stopCard(id: string): Promise<any>

  • 取消推送卡片

    Parameters

    • id: string

      卡片id

    Returns Promise<any>

Protected trigger

  • 发布事件

    Parameters

    Returns PushCard

Generated using TypeDoc