Class RedpackRain

红包雨核心类

Hierarchy

default
- RedpackRain

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new RedpackRain(config?: AppConfig): RedpackRain

Inherited from default.constructor
- Defined in src/apps/app.ts:70
Parameters
- Optional config: AppConfig
Returns RedpackRain

Properties

RedpackRainReceiveStatus

RedpackRainReceiveStatus: typeof RedpackRainReceiveStatus = ...

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: typeof RedpackRainEvents = ...

socketIOEvents

socketIOEvents: typeof SocketIOEvents = ...

socket.io 原生事件名称

Accessors

Protected SDKEventEmitter

get SDKEventEmitter(): EventEmitter

- Defined in src/apps/app.ts:111
Returns EventEmitter

Protected msgHandlers

get msgHandlers(): MsgHandlers

- Defined in src/apps/redpack-rain/redpack-rain.ts:37
模块对应所需的事件及处理方法

Returns MsgHandlers

Methods

Protected asyncGetXAuthToken

asyncGetXAuthToken(data: asyncGetterGeneratorParams): Promise<unknown>

Inherited from default.asyncGetXAuthToken
- Defined in src/apps/app.ts:501
Parameters
- data: asyncGetterGeneratorParams
Returns Promise<unknown>

bindSocketIOEvents

bindSocketIOEvents(): void

Inherited from default.bindSocketIOEvents
- Defined in src/apps/app.ts:200
绑定 socket.io 原生事件，

Returns void

destroy

destroy(): void

Inherited from default.destroy
- Defined in src/apps/app.ts:105
销毁实例

Returns void

getAppPendantList

getAppPendantList(): Promise<undefined | PendantListResData>

Inherited from default.getAppPendantList
- Defined in src/apps/app.ts:513
获取挂件列表

Returns Promise<undefined | PendantListResData>

Promise<PendantListResData | undefined>

grabRedpack

grabRedpack(params: GrabRedpackParams): Promise<ReceiveRedpackRainResult>

- Defined in src/apps/redpack-rain/redpack-rain.ts:144
领取红包

Parameters
- params: GrabRedpackParams
Returns Promise<ReceiveRedpackRainResult>

Private handleJoinRedpackResult

handleJoinRedpackResult(redpackInfoData: JoinRedpackRainResult, redpackId: string, redCacheId: string): void

- Defined in src/apps/redpack-rain/redpack-rain.ts:124
处理 join 接口参与过或已参与等正常状态

Parameters
- redpackInfoData: JoinRedpackRainResult
- redpackId: string
- redCacheId: string
Returns void

joinRedpackRain

joinRedpackRain(params: JoinRedpackRainParams): Promise<void>

- Defined in src/apps/redpack-rain/redpack-rain.ts:57
Parameters
- params: JoinRedpackRainParams
Returns Promise<void>

off

off(event: EType, listener: Listener): RedpackRain

Inherited from default.off
- Defined in src/apps/app.ts:405
取消订阅事件

Parameters
- event: EType
  
  事件名称
- listener: Listener
  
  事件处理器
Returns RedpackRain

this

on

on(event: EType, listener: Listener): RedpackRain

Inherited from default.on
- Defined in src/apps/app.ts:394
订阅事件

Parameters
- event: EType
  
  事件名称
- listener: Listener
  
  事件处理器
Returns RedpackRain

this

Protected onRedPaper

onRedPaper(msg: RedEnvelopeMsg): RedpackRain

- Defined in src/apps/redpack-rain/redpack-rain.ts:49
处理红包消息

Parameters
- msg: RedEnvelopeMsg
  
  红包消息
Returns RedpackRain

this

Private requestJoinRedpackRain

requestJoinRedpackRain(params: JoinRedpackRainParams): Promise<ApiResponseData<JoinRedpackRainResult>>

- Defined in src/apps/redpack-rain/redpack-rain.ts:97
发送 join 接口请求

Parameters
- params: JoinRedpackRainParams
Returns Promise<ApiResponseData<JoinRedpackRainResult>>

Private requestReceiveReapack

requestReceiveReapack(params: GrabRedpackParams): Promise<ApiResponseData<{ receiveData: ReceiveRedpackRainResult }>>

- Defined in src/apps/redpack-rain/redpack-rain.ts:171
发送 receive 请求

Parameters
- params: GrabRedpackParams
Returns Promise<ApiResponseData<{ receiveData: ReceiveRedpackRainResult }>>

trackLog

trackLog(data: ITrackEventData): Promise<void>

Inherited from default.trackLog
- Defined in src/apps/app.ts:551
Parameters
- data: ITrackEventData
Returns Promise<void>

unbindCustomEvent

unbindCustomEvent(): RedpackRain

Inherited from default.unbindCustomEvent
- Defined in src/apps/app.ts:364
解除监听 message 以外的聊天室消息

Returns RedpackRain

unbindEventHandlers

unbindEventHandlers(): RedpackRain

Inherited from default.unbindEventHandlers
- Defined in src/apps/app.ts:382
取消所有事件监听

Returns RedpackRain

Protected wrapCustomHandlers

wrapCustomHandlers(): CustomEventHandlers

Inherited from default.wrapCustomHandlers
- Defined in src/apps/app.ts:168
Returns CustomEventHandlers

Protected wrapSocketIOEventHandlers

wrapSocketIOEventHandlers(): CustomEventHandlers

Inherited from default.wrapSocketIOEventHandlers
- Defined in src/apps/app.ts:177
Returns CustomEventHandlers

Generated using TypeDoc