Class SignalHandler

Hierarchy

EventTarget
- SignalHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SignalHandler(socket: InnerBrowserStompSocket): SignalHandler

Overrides EventTarget.constructor
Parameters
- socket: InnerBrowserStompSocket
Returns SignalHandler

Properties

listenerMap

listenerMap: Record<EventTargetType, IEventPromisorObject[]>

Static BASE_LISTENER_MAP

BASE_LISTENER_MAP: Record<EventTargetType, IEventPromisorObject[]>

Static CD_SIGNAL_TO_SIGNAL_COMMAND_TYPE

CD_SIGNAL_TO_SIGNAL_COMMAND_TYPE: Record<string, SignalCommandType>

Static DEFAULT_EVENT_LISTENER_OPTIONS

DEFAULT_EVENT_LISTENER_OPTIONS: EventListenerOptions

Methods

addEventListener

addEventListener(type: EventTargetType, func: EventListenerType, options?: EventListenerOptions): () => void

Inherited from EventTarget.addEventListener

添加事件监听器

Parameters
- type: EventTargetType
  要监听的事件类型
- func: EventListenerType
  事件监听回调
- Optional options: EventListenerOptions
Returns () => void
若添加成功则返回一个函数, 用于移除事件监听
- - (): void
  - 添加事件监听器
    
    Returns void
    若添加成功则返回一个函数, 用于移除事件监听

addEventListeners

addEventListeners(types: EventTargetType[], func: EventListenerType, options?: EventListenerOptions): () => void

Inherited from EventTarget.addEventListeners

对多个事件添加同一个事件监听器

Parameters
- types: EventTargetType[]
  要监听的事件类型
- func: EventListenerType
  事件监听回调
- Optional options: EventListenerOptions
  设置监听器参数
Returns () => void
若添加成功则返回一个函数, 用于移除事件监听
- - (): void
  - 对多个事件添加同一个事件监听器
    
    Returns void
    若添加成功则返回一个函数, 用于移除事件监听

callCenteInviteResultListener

callCenteInviteResultListener(signal: Signal<SignalData>): Signal<SignalData>

Parameters
- signal: Signal<SignalData>
Returns Signal<SignalData>

callCenterCreateCompleteListener

callCenterCreateCompleteListener(signal: Signal<SignalData>): Signal<SignalData>

Parameters
- signal: Signal<SignalData>
Returns Signal<SignalData>

callCenterCreateListener

callCenterCreateListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

clearListener

clearListener(): void

Inherited from EventTarget.clearListener

清空所有绑定的事件

Returns void

conferencePropertyChangeListener

conferencePropertyChangeListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

conferenceStateChangeListener

conferenceStateChangeListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

createCDListener

createCDListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

destroyConferenceDeliveryListener

destroyConferenceDeliveryListener(): Promise<void>

Returns Promise<void>

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent

分发事件

Parameters
- event: Event
  分发的事件对象
Returns boolean
事件是否发送成功

dispatchEventLite

dispatchEventLite(type: EventTargetType, message?: EventTargetData, error?: string | number): boolean

Inherited from EventTarget.dispatchEventLite

简化的dispatchEvent接口

Parameters
- type: EventTargetType
- Optional message: EventTargetData
- Optional error: string | number
  具体错误类型, 此时 dispatchEventLite的 type 应是一个 xxxEventType.Error 类型
Returns boolean

hasListener

hasListener(type: EventTargetType): boolean

Inherited from EventTarget.hasListener

指定类型的事件是否被监听

Parameters
- type: EventTargetType
Returns boolean

inviteSipUserListener

inviteSipUserListener(signal: Signal<ConferenceSipParam>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<ConferenceSipParam>
Returns Promise<Signal<SignalData>>

joinConferenceListener

joinConferenceListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

leaveConferenceCompleteListener

leaveConferenceCompleteListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

leaveConferenceListener

leaveConferenceListener(): Promise<Signal<SignalData>>

Returns Promise<Signal<SignalData>>

leaveConferenceResultListener

leaveConferenceResultListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

listAllGroupsListener

listAllGroupsListener(signal: Signal<SignalData>): Promise<Signal<GuestGroupItem[]>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<GuestGroupItem[]>>

logReportInfoIdListener

logReportInfoIdListener(signal: Signal<RequestReportInfoIdParams>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<RequestReportInfoIdParams>
Returns Promise<Signal<SignalData>>

logReportInfoIdResultListener

logReportInfoIdResultListener(signal: Signal<SignalData>): Signal<SignalData>

Parameters
- signal: Signal<SignalData>
Returns Signal<SignalData>

messageReceiveListener

messageReceiveListener(signal: Signal<SignalData>): Signal<SignalData>

Parameters
- signal: Signal<SignalData>
Returns Signal<SignalData>

networkStateChangeListener

networkStateChangeListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

offlineConferenceNotifyListener

offlineConferenceNotifyListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

onlineMessageReceiveListener

onlineMessageReceiveListener(signal: Signal<SignalData>): Signal<SignalData>

Parameters
- signal: Signal<SignalData>
Returns Signal<SignalData>

participantLeaveListener

participantLeaveListener(signal: Signal<Participant>): Signal<Participant>

Parameters
- signal: Signal<Participant>
Returns Signal<Participant>

participantStateChangeListener

participantStateChangeListener(signal: Signal<SignalData>): Promise<Signal<Partial<Participant>[]>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<Partial<Participant>[]>>

passOfflineConferenceNotifyListener

passOfflineConferenceNotifyListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

queryRoomCompleteListener

queryRoomCompleteListener(signal: Signal<SignalData>): Signal<QueryChannelInfo>

Parameters
- signal: Signal<SignalData>
Returns Signal<QueryChannelInfo>

queryRoomListener

queryRoomListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

receiveSignalHandle

receiveSignalHandle(data: Record<string, unknown>): Promise<Signal<SignalData>>

Parameters
- data: Record<string, unknown>
Returns Promise<Signal<SignalData>>

removeEventListener

removeEventListener(type: EventTargetType, func: EventListenerType): boolean

Inherited from EventTarget.removeEventListener

移除事件监听器, 要提供与调用addEventListener或addEventListeners时相同的参数

Parameters
- type: EventTargetType
  要移除的事件监听器类型
- func: EventListenerType
  要移除的事件监听器
Returns boolean
返回 true 表示移除成功

reportLogListener

reportLogListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

requestUrgentCompleteListener

requestUrgentCompleteListener(signal: Signal<SignalData>): Signal<SignalData>

Parameters
- signal: Signal<SignalData>
Returns Signal<SignalData>

requestUrgentListener

requestUrgentListener(): Promise<Signal<SignalData>>

Returns Promise<Signal<SignalData>>

requestUrgentResultListener

requestUrgentResultListener(signal: Signal<SignalData>): Signal<SignalData>

Parameters
- signal: Signal<SignalData>
Returns Signal<SignalData>

requestWebRTCSDPListener

requestWebRTCSDPListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

selfStateChangeListener

selfStateChangeListener(signal: Signal<SignalData>): Promise<Signal<Partial<Participant>[]>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<Partial<Participant>[]>>

sendMessageListener

sendMessageListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

sendMessageResultListener

sendMessageResultListener(signal: Signal<SignalData>): Signal<SignalData>

Parameters
- signal: Signal<SignalData>
Returns Signal<SignalData>

sendOnlineMessageListener

sendOnlineMessageListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

sendSignalHandle

sendSignalHandle(signal: Pick<Signal<SignalData>, "data" | "command">, options?: { destination?: string; isPlainText?: boolean }): Promise<Signal<SignalData>>

Parameters
- signal: Pick<Signal<SignalData>, "data" | "command">
- Optional options: { destination?: string; isPlainText?: boolean }
  - Optional destination?: string
  - Optional isPlainText?: boolean
Returns Promise<Signal<SignalData>>

setMediaMergeListener

setMediaMergeListener(signal: Signal<Partial<ConferenceLayoutParam>>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<Partial<ConferenceLayoutParam>>
Returns Promise<Signal<SignalData>>

setRatioListener

setRatioListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

setStateListener

setStateListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

setVideoLevelListener

setVideoLevelListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

startRemoteRecordListener

startRemoteRecordListener(signal: Signal<ConferenceRecorderRemoteRecordOptions>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<ConferenceRecorderRemoteRecordOptions>
Returns Promise<Signal<SignalData>>

stopConferenceListener

stopConferenceListener(): Promise<void>

Returns Promise<void>

stopRemoteRecordListener

stopRemoteRecordListener(signal: Signal<SignalData>): Promise<Signal<SignalData>>

Parameters
- signal: Signal<SignalData>
Returns Promise<Signal<SignalData>>

Static addEventListener

addEventListener(type: EventTargetType, func: EventPromisorType, options?: EventListenerOptions): void

Parameters
- type: EventTargetType
- func: EventPromisorType
- Optional options: EventListenerOptions
Returns void

Generated using TypeDoc