WhiteboardCallbacks class 参考

适用版本：@shengwang/whiteboard 0.2.11。

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

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

类型结构（源码声明）

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

export class WhiteboardCallbacks

throwError	throwError?: (args: object) => void
onMessage	onMessage?: (args: object) => void
onBackgroundImageLoad	onBackgroundImageLoad?: (event: BackgroundImageLoadEvent) => void
onApplianceInitLoadingChange	onApplianceInitLoadingChange?: (event: ApplianceInitLoadingChangeEvent) => void
onSlidePageStateChanged	onSlidePageStateChanged?: (appId: string, page: number, pageCount: number) => void
onUnifiedPageStateChange	onUnifiedPageStateChange?: (state: UnifiedPageStateChange) => void
onLogger	onLogger?: (args: object) => void
onLocalLogStateChange	onLocalLogStateChange?: (state: object) => void
onRoomReady	onRoomReady?: () => void
sdkSetupFail	sdkSetupFail?: (error: SDKError) => void
onRoomPhaseChanged	onRoomPhaseChanged?: (roomPhase: RoomPhase) => void
onRoomStateChanged	onRoomStateChanged?: (roomState: RoomState) => void
onCanUndoStepsUpdate	onCanUndoStepsUpdate?: (steps: number) => void
onCanRedoStepsUpdate	onCanRedoStepsUpdate?: (steps: number) => void
onMagixEvent	onMagixEvent?: (event: EventEntry) => void
onHighFrequencyEvent	onHighFrequencyEvent?: (events: EventEntry[]) => void
onDisconnectWithError	onDisconnectWithError?: (error: RoomDisconnectError) => void
onKickedWithReason	onKickedWithReason?: (reason: RoomKickedReason) => void
setThrowError	setThrowError(callback: (args: object) => void) : WhiteboardCallbacks
setOnBackgroundImageLoad	setOnBackgroundImageLoad(callback: (event: BackgroundImageLoadEvent) => void) : WhiteboardCallbacks
setOnApplianceInitLoadingChange	setOnApplianceInitLoadingChange( callback: (event: ApplianceInitLoadingChangeEvent) => void, ) : WhiteboardCallbacks
setOnSlidePageStateChanged	setOnSlidePageStateChanged( callback: (appId: string, page: number, pageCount: number) => void, ) : WhiteboardCallbacks
setOnUnifiedPageStateChange	setOnUnifiedPageStateChange( callback: (state: UnifiedPageStateChange) => void, ) : WhiteboardCallbacks
setOnLogger	setOnLogger(callback: (args: object) => void) : WhiteboardCallbacks
setOnLocalLogStateChange	setOnLocalLogStateChange(callback: (state: object) => void) : WhiteboardCallbacks
setOnRoomReady	setOnRoomReady(callback: () => void) : WhiteboardCallbacks
setOnRoomPhaseChanged	setOnRoomPhaseChanged(callback: (roomPhase: RoomPhase) => void) : WhiteboardCallbacks
setOnRoomStateChanged	setOnRoomStateChanged(callback: (roomState: RoomState) => void) : WhiteboardCallbacks
setOnCanUndoStepsChanged	setOnCanUndoStepsChanged(callback: (steps: number) => void) : WhiteboardCallbacks
setOnCanRedoStepsChanged	setOnCanRedoStepsChanged(callback: (steps: number) => void) : WhiteboardCallbacks
setOnMagixEvent	setOnMagixEvent(callback: (event: EventEntry) => void) : WhiteboardCallbacks
setOnHighFrequencyEvent	setOnHighFrequencyEvent(callback: (events: EventEntry[]) => void) : WhiteboardCallbacks
setOnDisconnectWithError	setOnDisconnectWithError(callback: (error: RoomDisconnectError) => void) : WhiteboardCallbacks
setOnKickedWithReason	setOnKickedWithReason(callback: (reason: RoomKickedReason) => void) : WhiteboardCallbacks

函数说明

throwError

throwError?: (args: object) => void

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

参数

名称	描述
args	错误信息对象

onMessage

onMessage?: (args: object) => void

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

参数

名称	描述
args	消息对象

onBackgroundImageLoad

onBackgroundImageLoad?: (event: BackgroundImageLoadEvent) => void

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

onApplianceInitLoadingChange

onApplianceInitLoadingChange?: (event: ApplianceInitLoadingChangeEvent) => void

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

onSlidePageStateChanged

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

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

onUnifiedPageStateChange

onUnifiedPageStateChange?: (state: UnifiedPageStateChange) => void

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

onLogger

onLogger?: (args: object) => void

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

参数

名称	描述
args	日志信息对象

onLocalLogStateChange

onLocalLogStateChange?: (state: object) => void

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

参数

名称	描述
state	本地日志运行状态

onRoomReady

onRoomReady?: () => void

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

sdkSetupFail

sdkSetupFail?: (error: SDKError) => void

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

参数

名称	描述
error	初始化失败错误

onRoomPhaseChanged

onRoomPhaseChanged?: (roomPhase: RoomPhase) => void

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

参数

名称	描述
roomPhase	房间阶段

onRoomStateChanged

onRoomStateChanged?: (roomState: RoomState) => void

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

参数

名称	描述
roomState	房间状态

onCanUndoStepsUpdate

onCanUndoStepsUpdate?: (steps: number) => void

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

参数

名称	描述
steps	当前可撤销的步骤数

onCanRedoStepsUpdate

onCanRedoStepsUpdate?: (steps: number) => void

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

参数

名称	描述
steps	当前可重做的步骤数

onMagixEvent

onMagixEvent?: (event: EventEntry) => void

自定义事件回调函数。

参数

名称	描述
event	自定义事件

onHighFrequencyEvent

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

高频事件回调函数。

参数

名称	描述
events	高频事件列表

onDisconnectWithError

onDisconnectWithError?: (error: RoomDisconnectError) => void

房间断连错误回调函数。

参数

名称	描述
error	断连错误

onKickedWithReason

onKickedWithReason?: (reason: RoomKickedReason) => void

被踢下线回调函数。

参数

名称	描述
reason	原因

setThrowError

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

设置错误回调函数。

参数

名称	描述
callback	错误回调函数

@returns 当前的 WhiteboardCallbacks 实例

setOnBackgroundImageLoad

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

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

setOnApplianceInitLoadingChange

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

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

setOnSlidePageStateChanged

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

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

setOnUnifiedPageStateChange

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

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

setOnLogger

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

设置日志回调函数。

参数

名称	描述
callback	日志回调函数

@returns 当前的 WhiteboardCallbacks 实例

setOnLocalLogStateChange

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

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

参数

名称	描述
callback	本地日志状态变化回调函数

@returns 当前的 WhiteboardCallbacks 实例

setOnRoomReady

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

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

参数

名称	描述
callback	房间准备就绪的回调函数

@returns 当前的 WhiteboardCallbacks 实例

setOnRoomPhaseChanged

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

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

参数

名称	描述
callback	房间阶段变更的回调函数

@returns 当前的 WhiteboardCallbacks 实例

setOnRoomStateChanged

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

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

参数

名称	描述
callback	房间状态变化的回调函数

@returns 当前的 WhiteboardCallbacks 实例

setOnCanUndoStepsChanged

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

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

参数

名称	描述
callback	可撤销步骤更新的回调函数

@returns 当前的 WhiteboardCallbacks 实例

setOnCanRedoStepsChanged

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

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

参数

名称	描述
callback	可重做步骤更新的回调函数

@returns 当前的 WhiteboardCallbacks 实例

setOnMagixEvent

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

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

参数

名称	描述
callback	自定义事件回调函数

@returns 当前的 WhiteboardCallbacks 实例

setOnHighFrequencyEvent

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

设置高频事件回调函数。

参数

名称	描述
callback	高频事件回调函数

@returns 当前的 WhiteboardCallbacks 实例

setOnDisconnectWithError

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

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

参数

名称	描述
callback	房间断连错误回调函数

@returns 当前的 WhiteboardCallbacks 实例

setOnKickedWithReason

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

设置被踢下线回调函数。

参数

名称	描述
callback	被踢下线回调函数

@returns 当前的 WhiteboardCallbacks 实例