You need to enable JavaScript to run this app.
导航
回调
最近更新时间:2023.08.28 12:05:42首次发布时间:2023.08.07 20:50:14

IWhiteBoardRoomEvents

类型: interface

  • API
方法描述
onError错误回调。
onCreateWhiteBoard白板创建回调。调用 createWhiteBoard 成功创建白板后,房间内所有用户收到本回调。
onCurrentWhiteBoardChanged当前白板被更换时,房间内其他用户收到本回调。
onRemoveWhiteBoard白板被删除时,房间内其他用户收到本回调。

onError

错误回调。

  • 类型

    (event: { errorCode: ErrorCode; message?: string;}) => void
    
  • 参数

    • event

      类型: { errorCode: ErrorCode; message?: string | undefined; }

      错误事件。

      • 成员

        名称类型描述
        errorCodeErrorCode错误码。
        messagestring | undefined错误提示。

onCreateWhiteBoard

白板创建回调。调用 createWhiteBoard 成功创建白板后,房间内所有用户收到本回调。

  • 类型

    (event: CreateWhiteBoardResult) => void
    
  • 参数

onCurrentWhiteBoardChanged

当前白板被更换时,房间内其他用户收到本回调。

  • 类型

    (event: SwitchBoardResult) => void
    
  • 参数

onRemoveWhiteBoard

白板被删除时,房间内其他用户收到本回调。

IWhiteBoardEvents

类型: interface

  • API
方法描述
onError错误回调。
onCreatePagesProgress已创建一个新页面回调。
onPageIndexChanged当前页发生改变时触发此回调,例如,翻页或删除操作。监听本回调及时更新 UI 画面。
onPageCountChanged总页数发生改变时触发此回调,例如,创建新页面或删除操作。监听本回调及时更新 UI 画面。
onImageLoading加载图片时触发,包含背景图片元素,例如设置背景图片和切换白板时。

onError

错误回调。

  • 类型

    (event: { errorCode: ErrorCode; message?: string;}) => void
    
  • 参数

    • event

      类型: { errorCode: ErrorCode; message?: string | undefined; }

      错误事件。

      • 成员

        名称类型描述
        errorCodeErrorCode错误码。
        messagestring | undefined错误提示。

onCreatePagesProgress

已创建一个新页面回调。

  • 类型

    (event: CreatePageProgressResult) => void
    
  • 注意

    调用 createPages 后,房间中所有用户将收到本回调。

  • 参数

onPageIndexChanged

当前页发生改变时触发此回调,例如,翻页或删除操作。监听本回调及时更新 UI 画面。

onPageCountChanged

总页数发生改变时触发此回调,例如,创建新页面或删除操作。监听本回调及时更新 UI 画面。

  • 类型

    (event: { totalCount: number;}) => void
    
  • 注意

    成功调用 createPages 后,在本端和远端触发本回调。

  • 参数

    • event

      类型: { totalCount: number; }

      页数发生改变事件

      • 成员

        名称类型描述
        totalCountnumber新的总页数

onImageLoading

加载图片时触发,包含背景图片元素,例如设置背景图片和切换白板时。

  • 类型

    (event: { status: ImageLoadStatus; pageId: string; boardId: number; imageUrl: string;}) => void
    
  • 注意

    • 在加载白板背景时触发一次。
    • 使用静态转码功能时,本质也是将图片设置为页面背景,因此也有可能触发本回调。
  • 参数

    • event

      类型: { status: ImageLoadStatus; pageId: string; boardId: number; imageUrl: string; }

      图片加载事件。

      • 成员

        名称类型描述
        statusImageLoadStatus图片加载状态。
        pageIdstring页面 ID。
        boardIdnumber白板 ID。
        imageUrlstring图片 URL 地址。