Interface
IZegoSuperBoardApiCalledCallback
Universal callback interface of SuperBoard
Details
Supported version: v2.0.0.
Detailed description: After calling some interfaces of ZegoSuperBoardManager and ZegoSuperBoardSubView, the call result of this interface will be called back through the general callback interface.
Business scenario: After calling the ZegoSuperBoardManager and ZegoSuperBoardSubView interfaces, judge whether the interface call is successful.
Callback timing: after calling the corresponding interface including IZegoSuperBoardApiCalledCallback, and IZegoSuperBoardApiCalledCallback No null is passed.
Related interfaces: [inputText], [flipToPage], etc.
Declared in IZegoSuperBoardApiCalledCallback.java
Methods
onApiCalledResult
public void onApiCalledResult(int errorCode)IZegoSuperBoardApiCalledCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, 0 means success |
IZegoSuperBoardCacheFileListener
Methods
onCache
public onCacheParameters
| Name | Type | Description |
|---|---|---|
| state | ZegoSuperBoardCacheFileState | File caching is divided into two stages: Caching and Cached. |
| errorCode | int | The callback error code of the current stage, 0 means successful execution |
| infoMap | HashMap<String, Object> | The infoMap in the callbacks at different stages is inconsistent: Caching stage: If caching is normal, multiple callbacks will be generated, each time including file caching progress. For example, when the cache progress is 50%, the infoMap content is {"cache_percent":0.50,"request_seq"}; if the cache progress is 100%, the infoMap content is {"cache_percent":1.00,"request_seq"}. The value corresponding to request_seq is an integer, which is the identifier returned by the server when the interface is called, and is used to distinguish different files that are being cached. This parameter is only used when the user caches multiple files at the same time. Cache completion stage: If the cache is successful, a callback is generated, and the content of infoMap is {"request_seq"}. |
Details
Supported version: v2.0.0.
Detailed description: After calling the cacheFile interface, the status of the file cache process will be called back through this callback.
Business scenario: Files need to be cached locally.
Callback timing: After calling the cacheFile interface.
Related interface: [cacheFile]
IZegoSuperBoardCreateCallback
Methods
onViewCreated
public onViewCreatedParameters
| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, 0 means success |
| subViewModel | ZegoSuperBoardSubViewModel | The data of the successfully created subView. If the creation fails, this value may be null |
Details
Supported version: v2.0.0.
Detailed description: After calling the createWhiteboardView and createFileView interfaces, the result of the creation will come out through this callback.
Business scenario: creating whiteboards and files.
Callback timing: Call the createWhiteboardView and createFileView interfaces.
Related interfaces: [createWhiteboardView], [createFileView]
IZegoSuperBoardDestroyCallback
Methods
onViewDestroyed
public onViewDestroyedParameters
| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, 0 means success |
Details
Supported version: v2.0.0.
Detailed description: After calling the destroySuperBoardSubView interface, the result of deleting the subView will be thrown through the callback.
Business scenario: The specified subView needs to be deleted.
Callback timing: After calling the destroySuperBoardSubView interface.
Related interface: [destroySuperBoardSubView]
IZegoSuperBoardInitCallback
Methods
onInit
public onInitParameters
| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, 0 means success |
Details
Initialization result callback, please make sure that the initialization is successful. Do not re-initialize, if there are special requirements that need to be initialized multiple times, you can call unInit and then initialize again
- Available since: v2.0.0
IZegoSuperBoardQueryFileCachedListener
Methods
onQueryCached
public onQueryCachedParameters
| Name | Type | Description |
|---|---|---|
| errorCode | int | Callback error code, 0 means successful execution. |
| fileCached | boolean | Does the cache exist |
Details
After calling the cache file interface cacheFile, it will be thrown through this callback interface
IZegoSuperBoardQueryListCallback
Methods
onQuery
public onQueryParameters
| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, 0 means success |
| subViewModelList | ZegoSuperBoardSubViewModel[] | data of the successfully loaded subView |
| extraInfo | HashMap<String, String> |
Details
The callback interface of querySuperBoardSubViewList, which returns the data of the successfully loaded subView
- Available since: v2.0.0
IZegoSuperBoardScrollChangedListener
Methods
onScrollChange
public onScrollChangeParameters
| Name | Type | Description |
|---|---|---|
| currentPage | int | The current page number of the currently displayed SubView |
| pageCount | int | The total number of pages of SubView currently displayed |
| subViewModel | ZegoSuperBoardSubViewModel | Model information of the currently displayed SubView |
Details
Supported version: 2.0.0 and above.
Detailed description: When BoardView and SubView are scrolling, they will be notified through this callback
IZegoSuperBoardSizeChangedListener
Methods
onSizeChange
public onSizeChangeParameters
| Name | Type | Description |
|---|---|---|
| visibleSize | Size | The actual size of the visual content in the current BoardView |
| subViewModel | ZegoSuperBoardSubViewModel | Model information of the currently displayed SubView |
Details
Supported version: 2.0.0 and above.
Detailed description: When the size of the SuperBoardView changes, it will be notified through this callback
IZegoSuperBoardSwitchCallback
Methods
onViewSwitched
public onViewSwitchedParameters
| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, 0 means success |
Details
Supported version: 2.0.0 and above.
Detailed description: When the SubView is switched, it will be notified through this callback
IZegoSuperBoardUploadFileListener
Methods
onUpload
public onUploadParameters
| Name | Type | Description |
|---|---|---|
| state | ZegoSuperBoardUploadFileState | File upload is divided into two stages: upload and format conversion. |
| errorCode | int | The callback error code of the current stage, 0 means successful execution. |
| infoMap | HashMap<String, Object> | The infoMap in the [listener] callback at different stages is inconsistent: Upload stage: If the upload is normal, multiple callbacks will be generated, each time including the file upload progress. For example, when the upload progress is 50%, the infoMap content is {"upload_percent":0.50,"request_seq"}; when the upload progress is 100%, the infoMap content is {"upload_percent":1.00,"request_seq"}. The value corresponding to request_seq is an integer, which is the identifier returned by the server when the interface is called, and is used to distinguish different files being uploaded. This parameter is only used when the user uploads multiple files at the same time. Format conversion stage: If the conversion is successful, only one callback will be generated, including the converted file ID. For example, the current conversion is completed, the infoMap content is {"upload_fileid":"ekxxxxxxxxv","request_seq"}. The corresponding value of upload_fileid is the file fileID. |
Details
Supported version: 2.0.0 and above.
Detailed description: When the uploadFile method is called, it will be notified through this callback
IZegoSuperBoardViewListener
Callback for internal changes of ZegoSuperBoardView
Details
Supported version: 2.0.0 and above.
Detailed description: When the BoardView size changes or scrolls, it will be notified through this callback
Declared in IZegoSuperBoardViewListener.java
Methods
onScrollChange
public void onScrollChangeIZegoSuperBoardViewListener.javaParameters
| Name | Type | Description |
|---|---|---|
| currentPage | int | The current page number of the currently displayed SubView |
| pageCount | int | The total number of pages of SubView currently displayed |
| subViewModel | ZegoSuperBoardSubViewModel | Model information of the currently displayed SubView |
Details
If the currently displayed SubView is scrolled, it will be called back through this method.
- Available since: v2.0.0
onSizeChange
public void onSizeChangeIZegoSuperBoardViewListener.javaParameters
| Name | Type | Description |
|---|---|---|
| visibleSize | Size | The size of the visible area |
| subViewModel | ZegoSuperBoardSubViewModel | Data corresponding to the changed SubView |
Details
If the size of the currently displayed SubView changes, it will be called back through this method.
- Available since: v2.0.0