Class InnerJuphoonWeChatGuest

Hierarchy

InnerJuphoonWeChatConference
- InnerJuphoonWeChatGuest

Constructors

constructor

new InnerJuphoonWeChatGuest(): InnerJuphoonWeChatGuest

Overrides InnerJuphoonWeChatConference.constructor
Returns InnerJuphoonWeChatGuest

Properties

Readonly __constructorName

__constructorName: string

config

config: SDKConfig<InnerWeChatGuest, InnerBrowserStompSocket>

currentClient

currentClient: InnerWeChatGuest

最新创建的WeChatGuest对象

listenerMap

listenerMap: Record<EventTargetType, IEventListenerObject[]>

Readonly reporter

reporter: Reporter

Static DEFAULT_EVENT_LISTENER_OPTIONS

DEFAULT_EVENT_LISTENER_OPTIONS: EventListenerOptions

Static IGNORE_FUNCTION_MEMBER

IGNORE_FUNCTION_MEMBER: PropertyKey[]

Static reporterManager

reporterManager: ReporterManager

Accessors

firstClientCreated

get firstClientCreated(): Promise<void>

Returns Promise<void>

Methods

addEventListener

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

Inherited from InnerJuphoonWeChatConference.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 InnerJuphoonWeChatConference.addEventListeners

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

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

clearListener

clearListener(): void

Inherited from InnerJuphoonWeChatConference.clearListener

清空所有绑定的事件

Returns void

createConferenceClient

createConferenceClient(appKey: string, token: string, socketAddress?: string): InnerWeChatConference

Inherited from InnerJuphoonWeChatConference.createConferenceClient

创建会议客户端

Parameters
- appKey: string
  appKey
- token: string
  自行获取到的token
- Optional socketAddress: string
  WebSocket的连接地址
Returns InnerWeChatConference

createGuestClient

createGuestClient(appKey: string, token: string, socketAddress?: string): InnerWeChatGuest

Parameters
- appKey: string
- token: string
- Optional socketAddress: string
Returns InnerWeChatGuest

createWebSocketClient

createWebSocketClient(config: SDKConfig<InnerWeChatConference, InnerBrowserStompSocket>): InnerBrowserStompSocket

Inherited from InnerJuphoonWeChatConference.createWebSocketClient
Parameters
- config: SDKConfig<InnerWeChatConference, InnerBrowserStompSocket>
Returns InnerBrowserStompSocket

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from InnerJuphoonWeChatConference.dispatchEvent

分发事件

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

dispatchEventLite

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

Inherited from InnerJuphoonWeChatConference.dispatchEventLite

简化的dispatchEvent接口

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

getToken

getToken(url?: string): Promise<string>

Inherited from InnerJuphoonWeChatConference.getToken

获取用于校验的token

token应由集成方从第三方接口获取, 该接口只作为集成测试使用.

Parameters
- Optional url: string
  获取token的地址
Returns Promise<string>

getVersion

getVersion(): Record<string, unknown>

Overrides InnerJuphoonWeChatConference.getVersion

获取SDK版本信息

Returns Record<string, unknown>

hasListener

hasListener(type: EventTargetType): boolean

Inherited from InnerJuphoonWeChatConference.hasListener

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

Parameters
- type: EventTargetType
Returns boolean

removeEventListener

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

Inherited from InnerJuphoonWeChatConference.removeEventListener

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

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

setConfig

setConfig(config: Partial<SDKConfig<InnerWeChatConference, InnerBrowserStompSocket>>): void

Inherited from InnerJuphoonWeChatConference.setConfig

配置SDK参数

Parameters
- config: Partial<SDKConfig<InnerWeChatConference, InnerBrowserStompSocket>>
  见SDKConfig
Returns void

toString

toString(): string

Inherited from InnerJuphoonWeChatConference.toString
Returns string

Generated using TypeDoc