Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Tuwen

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _bindedCustomEventHandlers

_bindedCustomEventHandlers: CustomEventHandlers = ...

绑定了 this 上下文的 message 以外事件处理器

Protected _bindedMsgHandlers

_bindedMsgHandlers: MsgHandlers = ...

绑定了 this 上下文的 msg 处理器

Protected _bindedSocketIOEventsHandlers

_bindedSocketIOEventsHandlers: CustomEventHandlers = ...

socket.io 事件处理

Protected _liveApi

_liveApi: default

直播后台 api ajax 工具

Protected _otherApi

_otherApi: default

其他 api ajax 工具

Protected _watchApi

_watchApi: default

观看页接口工具

events

events: SocketEventTypes = ...

相关聊天室事件

masterUserInfo

masterUserInfo: UserInfoBase = {}

主持人信息

messageType

messageType: string = ...

列表消息类型, 默认为图文

messages

messages: MessageItem[] = []

消息流

socketIOEvents

socketIOEvents: typeof SocketIOEvents = ...

socket.io 原生事件名称

topMessages

topMessages: MessageItem[] = []

顶部消息流

total

total: number = 0

消息数量

Accessors

Protected SDKEventEmitter

  • get SDKEventEmitter(): EventEmitter

  • Returns EventEmitter

Protected msgHandlers

  • 模块对应所需的事件及处理方法

    Returns MsgHandlers

Methods

_delMessage

  • 删除数据

    Parameters

    Returns void

_updateMessage

  • 创建/编辑数据

    Parameters

    Returns void

_updateStickyMessage

  • 添加/取消置顶消息 通过top判断消息类型, N为移除, Y为添加

    Parameters

    Returns void

_updateUserInfo

  • 更新用户信息

    Parameters

    Returns void

Protected asyncGetXAuthToken

  • asyncGetXAuthToken(data: asyncGetterGeneratorParams): Promise<unknown>

  • Parameters

    • data: asyncGetterGeneratorParams

    Returns Promise<unknown>

bindSocketIOEvents

  • bindSocketIOEvents(): void

changeMessageType

  • changeMessageType(type: MessageType): Promise<string>

  • 修改列表图文类型

    Parameters

    Returns Promise<string>

clearMessageList

  • clearMessageList(): void

  • 清空聊天消息

    Returns void

destroy

  • destroy(): void

  • 销毁实例

    Returns void

getAppPendantList

getMessageIndexById

  • getMessageIndexById(id: number): { messageIndex: number; topMessageIndex: number }

  • 查找id对应消息列表中所在索引

    Parameters

    • id: number

    Returns { messageIndex: number; topMessageIndex: number }

    • messageIndex: number
    • topMessageIndex: number

getTuwenInfo

  • 获取直播列表信息 (包含主持人信息)

    Parameters

    • startId: string = ''

      数据起始 ID, startId为空则表示初始化数据,默认请求前十条数据

    Returns Promise<TuwenContent>

off

  • 取消订阅事件

    Parameters

    Returns Tuwen

    this

on

  • 订阅事件

    Parameters

    Returns Tuwen

    this

trackLog

  • trackLog(data: ITrackEventData): Promise<void>

  • Parameters

    • data: ITrackEventData

    Returns Promise<void>

unbindCustomEvent

  • unbindCustomEvent(): Tuwen

unbindEventHandlers

  • unbindEventHandlers(): Tuwen

Protected wrapCustomHandlers

Protected wrapSocketIOEventHandlers

Generated using TypeDoc