Interface
IZegoSuperBoardApiCalledCallback
SuperBoard的通用回调接口
详情
在调用 ZegoSuperBoardManager、ZegoSuperBoardSubView 部分接口后会通过通用回调接口的方式回调此次接口的调用结果。
- 业务场景：调用 ZegoSuperBoardManager、ZegoSuperBoardSubView 接口后判断此次接口调用是否成功。
回调时机：调用对应包含 IZegoSuperBoardApiCalledCallback 接口之后，且 IZegoSuperBoardApiCalledCallback 没有传null.
- 相关接口： [inputText]、[flipToPage]等
- 支持版本：2.0.0及以上。
Declared in IZegoSuperBoardApiCalledCallback.java
方法
onApiCalledResult
public void onApiCalledResult(int errorCode)IZegoSuperBoardApiCalledCallback.java| 名称 | 类型 | 描述 |
|---|---|---|
| errorCode | int | 错误码，0表示成功 |
IZegoSuperBoardCacheFileListener
方法
onCache
public onCache参数
| 名称 | 类型 | 描述 |
|---|---|---|
| state | ZegoSuperBoardCacheFileState | 文件缓存分为缓存 Caching 和缓存完成 Cached 两个阶段 |
| errorCode | int | 当前阶段的回调错误码，0表示执行成功 |
| infoMap | HashMap<String, Object> | 不同阶段回调中的 infoMap 不一致： 缓存阶段：如果正常缓存，会产生多次回调，每次都包含文件缓存进度。例如缓存进度为 50%时，则 infoMap 内容为 {"cache_percent":0.50,"request_seq"}；缓存进度为 100%，则 infoMap 内容为 {"cache_percent":1.00,"request_seq"}。其中 request_seq 对应的值是一个整数，是接口调用时由服务端返回的标识，用于区分正在缓存的不同文件。该参数只有用户同时缓存多个文件时才会用到。 缓存完成阶段：如果缓存成功，产生一次回调，infoMap 内容为 {"request_seq"}。 |
详情
调用 cacheFile 接口后,缓存文件过程的状态会通过此回调出来。
- 业务场景：需要缓存文件到本地。
回调时机： 调用cacheFile接口之后。
- 相关接口： [cacheFile]
- 支持版本：2.0.0及以上。
IZegoSuperBoardCreateCallback
方法
onViewCreated
public onViewCreated参数
| 名称 | 类型 | 描述 |
|---|---|---|
| errorCode | int | 错误码，0表示成功 |
| subViewModel | ZegoSuperBoardSubViewModel | 创建成功的subView的数据，如果创建失败，这个值可能为空 |
详情
调用 createWhiteboardView、createFileView 接口后, 创建后的结果通过此回调出来。
- 业务场景：创建白板、文件。
回调时机： 调用 createWhiteboardView、createFileView 接口。
- 相关接口： [createWhiteboardView]、[createFileView]
- 支持版本：2.0.0及以上。
IZegoSuperBoardDestroyCallback
方法
onViewDestroyed
public onViewDestroyed参数
| 名称 | 类型 | 描述 |
|---|---|---|
| errorCode | int | 错误码，0表示成功 |
详情
调用 destroySuperBoardSubView 接口后 删除subView的结果会通过回调抛出来。
- 业务场景：需要删除指定的subView。
回调时机： 调用 destroySuperBoardSubView 接口之后。
- 相关接口： [destroySuperBoardSubView]
- 支持版本：2.0.0及以上。
IZegoSuperBoardInitCallback
方法
onInit
public onInit参数
| 名称 | 类型 | 描述 |
|---|---|---|
| errorCode | int | 错误码，0表示成功 |
详情
初始化结果回调，请确保初始化成功。请勿重复初始化，如果有特殊需求需要多次初始化，可以调用 unInit 后再次初始化
- 支持版本：2.0.0及以上。
IZegoSuperBoardQueryFileCachedListener
方法
onQueryCached
public onQueryCached参数
| 名称 | 类型 | 描述 |
|---|---|---|
| errorCode | int | 回调错误码，0表示执行成功。 |
| fileCached | boolean | 缓存是否存在 |
详情
调用缓存文件接口 cacheFile 后会通过此回调接口抛出
IZegoSuperBoardQueryListCallback
方法
onQuery
public onQuery参数
| 名称 | 类型 | 描述 |
|---|---|---|
| errorCode | int | 错误码，0表示成功 |
| subViewModelList | ZegoSuperBoardSubViewModel[] | 加载成功的subView的数据 |
| extraInfo | HashMap<String, String> |
详情
querySuperBoardSubViewList 的回调接口，返回加载成功的subView的数据
- 支持版本：2.0.0及以上。
IZegoSuperBoardScrollChangedListener
方法
onScrollChange
public onScrollChange参数
| 名称 | 类型 | 描述 |
|---|---|---|
| currentPage | int | 当前展示的SubView的当前页码 |
| pageCount | int | 当前展示的SubView的总页数 |
| subViewModel | ZegoSuperBoardSubViewModel | 当前展示的SubView的Model信息 |
详情
当BoardView、SubView在滚动时，会通过此回调通知出去
- 支持版本：2.0.0及以上。
IZegoSuperBoardSizeChangedListener
方法
onSizeChange
public onSizeChange参数
| 名称 | 类型 | 描述 |
|---|---|---|
| visibleSize | Size | 当前BoardView中可视内容的实际大小 |
| subViewModel | ZegoSuperBoardSubViewModel | 当前展示的SubView的Model信息 |
详情
当SuperBoardView大小改变后，会通过此回调通知出去
- 支持版本：2.0.0及以上。
IZegoSuperBoardSwitchCallback
方法
onViewSwitched
public onViewSwitched参数
| 名称 | 类型 | 描述 |
|---|---|---|
| errorCode | int | 错误码，0表示成功 |
详情
当切换SubView后，会通过此回调通知出去
- 支持版本：2.0.0及以上。
IZegoSuperBoardUploadFileListener
方法
onUpload
public onUpload参数
| 名称 | 类型 | 描述 |
|---|---|---|
| state | ZegoSuperBoardUploadFileState | 文件上传分为上传 Upload 和格式转换 Convert 两个阶段。 |
| errorCode | int | 当前阶段的回调错误码，0表示执行成功。 |
| infoMap | HashMap<String, Object> | 不同阶段 [listener] 回调中的 infoMap 不一致： 上传阶段：如果正常上传，会产生多次回调，每次都包含文件上传进度。例如上传进度为 50%时，则 infoMap 内容为 {"upload_percent":0.50,"request_seq"}；上传进度为 100%，则 infoMap 内容为 {"upload_percent":1.00,"request_seq"}。其中 request_seq 对应的值是一个整数，是接口调用时由服务端返回的标识，用于区分正在上传的不同文件。该参数只有用户同时上传多个文件时才会用到。 格式转换阶段：如果转换成功，只产生一次回调，包含转换后的文件 ID。例如当前转换完成，则 infoMap 内容为 {"upload_fileid":"ekxxxxxxxxv","request_seq"}。 upload_fileid 对应的值即为文件 fileID。 |
详情
当调用 uploadFile 方法时，会通过此回调通知出去
- 支持版本：2.0.0及以上。
IZegoSuperBoardViewListener
ZegoSuperBoardView 的内部变更的回调
详情
当BoardView 大小变更、滚动时，会通过此回调通知出去
- 支持版本：2.0.0及以上。
Declared in IZegoSuperBoardViewListener.java
方法
onScrollChange
public void onScrollChangeIZegoSuperBoardViewListener.java参数
| 名称 | 类型 | 描述 |
|---|---|---|
| currentPage | int | 当前展示的SubView的当前页码 |
| pageCount | int | 当前展示的SubView的总页数 |
| subViewModel | ZegoSuperBoardSubViewModel | 当前展示的SubView的Model信息 |
详情
当前展示的SubView如果滚动了，会通过此方法回调出来。
- 支持版本：2.0.0。
onSizeChange
public void onSizeChangeIZegoSuperBoardViewListener.java参数
| 名称 | 类型 | 描述 |
|---|---|---|
| visibleSize | Size | 可见区域的大小 |
| subViewModel | ZegoSuperBoardSubViewModel | 发生变化的SubView对应的数据 |
详情
当前展示的SubView如果大小变了，会通过此方法回调出来。
- 支持版本：2.0.0 以上。