WhiteboardCallbacks class 参考

详细描述Copy Anchor Link

适用版本：@shengwang/whiteboard 0.2.11。

房间、课件、日志及初始化事件回调；实际传给 Whiteboard 组件的 callbacks 参数。

可从 @shengwang/whiteboard 直接导入 WhiteboardCallbacks。

类型结构（源码声明）Copy Anchor Link

下方源码文件的 export 声明不等同于 SDK 包入口导出；业务导入方式以上方说明为准。

export class WhiteboardCallbacks

函数说明Copy Anchor Link

throwErrorCopy Anchor Link

throwError?: (args: object) => void

错误回调函数，处理错误信息。

参数Copy Anchor Link

onMessageCopy Anchor Link

onMessage?: (args: object) => void

消息回调函数，用于处理接收到的消息。

参数Copy Anchor Link

onBackgroundImageLoadCopy Anchor Link

onBackgroundImageLoad?: (event: BackgroundImageLoadEvent) => void

类型成员，必填性和返回类型以声明为准。

onApplianceInitLoadingChangeCopy Anchor Link

onApplianceInitLoadingChange?: (event: ApplianceInitLoadingChangeEvent) => void

类型成员，必填性和返回类型以声明为准。

onSlidePageStateChangedCopy Anchor Link

onSlidePageStateChanged?: (appId: string, page: number, pageCount: number) => void

Slide 页面状态变化回调，页码从 1 开始。

onUnifiedPageStateChangeCopy Anchor Link

onUnifiedPageStateChange?: (state: UnifiedPageStateChange) => void

MainView, DocsViewer, Slide or Presentation page/scale state change.

onLoggerCopy Anchor Link

onLogger?: (args: object) => void

日志回调函数，用于记录日志。

参数Copy Anchor Link

onLocalLogStateChangeCopy Anchor Link

onLocalLogStateChange?: (state: object) => void

WebView 内本地日志状态变化回调。

参数Copy Anchor Link

onRoomReadyCopy Anchor Link

onRoomReady?: () => void

房间准备就绪回调函数，房间准备好后调用。

sdkSetupFailCopy Anchor Link

sdkSetupFail?: (error: SDKError) => void

SDK 初始化失败回调。触发后需要重新初始化 SDK，再重新加入房间。

参数Copy Anchor Link

onRoomPhaseChangedCopy Anchor Link

onRoomPhaseChanged?: (roomPhase: RoomPhase) => void

房间状态变更回调函数，当房间阶段发生变化时调用。

参数Copy Anchor Link

onRoomStateChangedCopy Anchor Link

onRoomStateChanged?: (roomState: RoomState) => void

房间状态变化回调函数，当房间状态变化时调用。

参数Copy Anchor Link

onCanUndoStepsUpdateCopy Anchor Link

onCanUndoStepsUpdate?: (steps: number) => void

可撤销步骤更新回调函数，当可撤销步骤发生变化时调用。

参数Copy Anchor Link

onCanRedoStepsUpdateCopy Anchor Link

onCanRedoStepsUpdate?: (steps: number) => void

可重做步骤更新回调函数，当可重做步骤发生变化时调用。

参数Copy Anchor Link

onMagixEventCopy Anchor Link

onMagixEvent?: (event: EventEntry) => void

自定义事件回调函数。

参数Copy Anchor Link

onHighFrequencyEventCopy Anchor Link

onHighFrequencyEvent?: (events: EventEntry[]) => void

高频事件回调函数。

参数Copy Anchor Link

onDisconnectWithErrorCopy Anchor Link

onDisconnectWithError?: (error: RoomDisconnectError) => void

房间断连错误回调函数。

参数Copy Anchor Link

onKickedWithReasonCopy Anchor Link

onKickedWithReason?: (reason: RoomKickedReason) => void

被踢下线回调函数。

参数Copy Anchor Link

setThrowErrorCopy Anchor Link

setThrowError(callback: (args: object) => void) : WhiteboardCallbacks

设置错误回调函数。

参数Copy Anchor Link

@returns 当前的 WhiteboardCallbacks 实例

setOnBackgroundImageLoadCopy Anchor Link

setOnBackgroundImageLoad(callback: (event: BackgroundImageLoadEvent) => void) : WhiteboardCallbacks

setOnBackgroundImageLoad：WhiteboardCallbacks 的公开成员。参数和返回类型见下方签名。

setOnApplianceInitLoadingChangeCopy Anchor Link

setOnApplianceInitLoadingChange( callback: (event: ApplianceInitLoadingChangeEvent) => void, ) : WhiteboardCallbacks

setOnApplianceInitLoadingChange：WhiteboardCallbacks 的公开成员。参数和返回类型见下方签名。

setOnSlidePageStateChangedCopy Anchor Link

setOnSlidePageStateChanged( callback: (appId: string, page: number, pageCount: number) => void, ) : WhiteboardCallbacks

setOnSlidePageStateChanged：WhiteboardCallbacks 的公开成员。参数和返回类型见下方签名。

setOnUnifiedPageStateChangeCopy Anchor Link

setOnUnifiedPageStateChange( callback: (state: UnifiedPageStateChange) => void, ) : WhiteboardCallbacks

setOnUnifiedPageStateChange：WhiteboardCallbacks 的公开成员。参数和返回类型见下方签名。

setOnLoggerCopy Anchor Link

setOnLogger(callback: (args: object) => void) : WhiteboardCallbacks

设置日志回调函数。

参数Copy Anchor Link

@returns 当前的 WhiteboardCallbacks 实例

setOnLocalLogStateChangeCopy Anchor Link

setOnLocalLogStateChange(callback: (state: object) => void) : WhiteboardCallbacks

设置 WebView 内本地日志状态变化回调函数。

参数Copy Anchor Link

@returns 当前的 WhiteboardCallbacks 实例

setOnRoomReadyCopy Anchor Link

setOnRoomReady(callback: () => void) : WhiteboardCallbacks

设置房间准备就绪回调函数。

参数Copy Anchor Link

@returns 当前的 WhiteboardCallbacks 实例

setOnRoomPhaseChangedCopy Anchor Link

setOnRoomPhaseChanged(callback: (roomPhase: RoomPhase) => void) : WhiteboardCallbacks

设置房间阶段变更回调函数。

参数Copy Anchor Link

@returns 当前的 WhiteboardCallbacks 实例

setOnRoomStateChangedCopy Anchor Link

setOnRoomStateChanged(callback: (roomState: RoomState) => void) : WhiteboardCallbacks

设置房间状态变化回调函数。

参数Copy Anchor Link

@returns 当前的 WhiteboardCallbacks 实例

setOnCanUndoStepsChangedCopy Anchor Link

setOnCanUndoStepsChanged(callback: (steps: number) => void) : WhiteboardCallbacks

设置可撤销步骤更新回调函数。

参数Copy Anchor Link

@returns 当前的 WhiteboardCallbacks 实例

setOnCanRedoStepsChangedCopy Anchor Link

setOnCanRedoStepsChanged(callback: (steps: number) => void) : WhiteboardCallbacks

设置可重做步骤更新回调函数。

参数Copy Anchor Link

@returns 当前的 WhiteboardCallbacks 实例

setOnMagixEventCopy Anchor Link

setOnMagixEvent(callback: (event: EventEntry) => void) : WhiteboardCallbacks

设置自定义事件回调函数。

参数Copy Anchor Link

@returns 当前的 WhiteboardCallbacks 实例

setOnHighFrequencyEventCopy Anchor Link

setOnHighFrequencyEvent(callback: (events: EventEntry[]) => void) : WhiteboardCallbacks

设置高频事件回调函数。

参数Copy Anchor Link

@returns 当前的 WhiteboardCallbacks 实例

setOnDisconnectWithErrorCopy Anchor Link

setOnDisconnectWithError(callback: (error: RoomDisconnectError) => void) : WhiteboardCallbacks

设置房间断连错误回调函数。

参数Copy Anchor Link

@returns 当前的 WhiteboardCallbacks 实例

setOnKickedWithReasonCopy Anchor Link

setOnKickedWithReason(callback: (reason: RoomKickedReason) => void) : WhiteboardCallbacks

设置被踢下线回调函数。

参数Copy Anchor Link

@returns 当前的 WhiteboardCallbacks 实例