Class Base<ActionMap, EventMap>

核心的基类继承标准化的 EventTarget，提供标准的事件管理默认使用已实现的 DefaultActionMap 和 DefaultEventMap 类型

Type Parameters

ActionMap extends BaseMap = DefaultActionMap
EventMap extends BaseMap = DefaultEventMap

Hierarchy (View Summary)

StandardEventTarget
- Base
  - RealseeVRSignalsClient
  - RealseeVRSignalsRemote

Constructors

constructor

new Base<
    ActionMap extends BaseMap = DefaultActionMap,
    EventMap extends BaseMap = DefaultEventMap,
>(
    options?: Partial<BaseOptions<ActionMap>>,
): Base<ActionMap, EventMap>
构造函数接受一个可选的 Options 对象。它首先初始化 logger，然后检测是否在 iframe 中运行。
Type Parameters
- ActionMap extends BaseMap = DefaultActionMap
- EventMap extends BaseMap = DefaultEventMap
Parameters
- Optionaloptions: Partial<BaseOptions<ActionMap>>
  包含 VR 链接、元素和日志级别的选项对象。
Returns Base<ActionMap, EventMap>
Overrides StandardEventTarget.constructor
- Defined in src/Base.ts:109

Accessors

actionMap

get actionMap(): undefined | Partial<ActionMap>
获取支持的方法列表（向后兼容）

Returns undefined | Partial<ActionMap>
- Defined in src/Base.ts:52

actionManager

get actionManager(): StandardActionManager<ActionMap>
获取 Action 管理器

Returns StandardActionManager<ActionMap>
- Defined in src/Base.ts:64

connectionStatus

get connectionStatus(): ConnectionStatus
获取连接状态

Returns ConnectionStatus
- Defined in src/Base.ts:93

Methods

getOptions

getOptions(): Partial<BaseOptions<ActionMap>>
获取配置选项

Returns Partial<BaseOptions<ActionMap>>
- Defined in src/Base.ts:100

onReady

onReady(callback: () => void): void
当消息桥接准备好时，执行回调
Parameters
- callback: () => void
Returns void
- Defined in src/Base.ts:278

onConnectionStatusChange

onConnectionStatusChange(
callback: (status: ConnectionStatus) => void,
): undefined | (() => void)
监听连接状态变化
Parameters
- callback: (status: ConnectionStatus) => void
Returns undefined | (() => void)
- Defined in src/Base.ts:293

offConnectionStatusChange

offConnectionStatusChange(
callback: (status: ConnectionStatus) => void,
): undefined | void
取消连接状态监听
Parameters
- callback: (status: ConnectionStatus) => void
Returns undefined | void
- Defined in src/Base.ts:301

reconnect

reconnect(): void
手动重连

Returns void
- Defined in src/Base.ts:308

sendEvent

sendEvent<EventName extends string | number | symbol>(
eventName: EventName,
eventData: Parameters<EventMap[EventName]>[0],
): void
发送事件
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
- eventData: Parameters<EventMap[EventName]>[0]
Returns void
- Defined in src/Base.ts:337

send

send<K extends string | number | symbol>(
action: K,
data: Parameters<ActionMap[K]>[0],
): Promise<ReturnType<ActionMap[K]>>
发送 Action 请求
Type Parameters
- K extends string | number | symbol
Parameters
- action: K
- data: Parameters<ActionMap[K]>[0]
Returns Promise<ReturnType<ActionMap[K]>>
- Defined in src/Base.ts:356

on

on<EventName extends string | number | symbol>(
eventName: EventName,
callback: EventMap[EventName],
): () => void
监听事件（向后兼容，内部使用标准 addEventListener）
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
- callback: EventMap[EventName]
Returns () => void
- Defined in src/Base.ts:376

off

off<EventName extends string | number | symbol>(
eventName: EventName,
callback: EventMap[EventName],
): void
取消监听事件（向后兼容，内部使用标准 removeEventListener）
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
- callback: EventMap[EventName]
Returns void
- Defined in src/Base.ts:395

once

once<EventName extends string | number | symbol>(
eventName: EventName,
callback: EventMap[EventName],
): () => void
只监听一次事件（向后兼容，内部使用标准 addEventListener）
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
- callback: EventMap[EventName]
Returns () => void
- Defined in src/Base.ts:404

dispose

dispose(): void
销毁

Returns void
- Defined in src/Base.ts:428

addEventListener

addEventListener(
    type: string,
    listener: null | EventListener | EventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
添加事件监听器（标准方法）
Parameters
- type: string
  事件类型
- listener: null | EventListener | EventListenerObject
  事件监听器
- Optionaloptions: boolean | AddEventListenerOptions
  选项
Returns void
Inherited from StandardEventTarget.addEventListener
- Defined in src/StandardEventTarget.ts:12

removeEventListener

removeEventListener(
    type: string,
    listener: null | EventListener | EventListenerObject,
    options?: boolean | EventListenerOptions,
): void
移除事件监听器（标准方法）
Parameters
- type: string
  事件类型
- listener: null | EventListener | EventListenerObject
  事件监听器
- Optionaloptions: boolean | EventListenerOptions
  选项
Returns void
Inherited from StandardEventTarget.removeEventListener
- Defined in src/StandardEventTarget.ts:26

dispatchEvent

dispatchEvent(event: Event): boolean
分发事件（标准方法）
Parameters
- event: Event
  事件对象
Returns boolean
是否被取消
Inherited from StandardEventTarget.dispatchEvent
- Defined in src/StandardEventTarget.ts:39

dispatchCustomEvent

dispatchCustomEvent<T = any>(
    type: string,
    detail?: T,
    options?: CustomEventInit<T>,
): boolean
创建并分发自定义事件
Type Parameters
- T = any
Parameters
- type: string
  事件类型
- Optionaldetail: T
  事件详情
- Optionaloptions: CustomEventInit<T>
  事件选项
Returns boolean
是否被取消
Inherited from StandardEventTarget.dispatchCustomEvent
- Defined in src/StandardEventTarget.ts:50

dispatchBuiltInEvent

dispatchBuiltInEvent(type: string, options?: EventInit): boolean
创建并分发内置事件
Parameters
- type: string
  事件类型
- Optionaloptions: EventInit
  事件选项
Returns boolean
是否被取消
Inherited from StandardEventTarget.dispatchBuiltInEvent
- Defined in src/StandardEventTarget.ts:70

hasEventListener

hasEventListener(type: string): boolean
检查是否有指定类型的事件监听器
Parameters
- type: string
  事件类型
Returns boolean
是否有监听器
Inherited from StandardEventTarget.hasEventListener
- Defined in src/StandardEventTarget.ts:84

getListenerCount

getListenerCount(type: string): number
获取事件监听器数量（近似值）
Parameters
- type: string
  事件类型
Returns number
监听器数量
Inherited from StandardEventTarget.getListenerCount
- Defined in src/StandardEventTarget.ts:95

removeAllListeners

removeAllListeners(type: string): void
移除指定类型的所有事件监听器
Parameters
- type: string
  事件类型
Returns void
Inherited from StandardEventTarget.removeAllListeners
- Defined in src/StandardEventTarget.ts:105

addEventListenerWithAbort

addEventListenerWithAbort(
    type: string,
    listener: null | EventListener | EventListenerObject,
    options?: AddEventListenerOptions,
    signal?: AbortSignal,
): () => void
使用 AbortController 添加事件监听器
Parameters
- type: string
  事件类型
- listener: null | EventListener | EventListenerObject
  事件监听器
- Optionaloptions: AddEventListenerOptions
  选项
- Optionalsignal: AbortSignal
  AbortSignal
Returns () => void
清理函数
Inherited from StandardEventTarget.addEventListenerWithAbort
- Defined in src/StandardEventTarget.ts:119

Class Base<ActionMap, EventMap>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Base<ActionMap, EventMap>

Accessors

actionMap

Returns undefined | Partial<ActionMap>

actionManager

Returns StandardActionManager<ActionMap>

connectionStatus

Returns ConnectionStatus

Methods

getOptions

Returns Partial<BaseOptions<ActionMap>>

onReady

Parameters

Returns void

onConnectionStatusChange

Parameters

Returns undefined | (() => void)

offConnectionStatusChange

Parameters

Returns undefined | void

reconnect

Returns void

sendEvent

Type Parameters

Parameters

Returns void

send

Type Parameters

Parameters

Returns Promise<ReturnType<ActionMap[K]>>

on

Type Parameters

Parameters

Returns () => void

off

Type Parameters

Parameters

Returns void

once

Type Parameters

Parameters

Returns () => void

dispose

Returns void

addEventListener

Parameters

Returns void

removeEventListener

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

dispatchCustomEvent

Type Parameters

Parameters

Returns boolean

dispatchBuiltInEvent

Parameters

Returns boolean

hasEventListener

Parameters

Returns boolean

getListenerCount

Parameters

Returns number

removeAllListeners

Parameters

Returns void