Class

• Value range: Positive integer greater than 0.

• Value range: Positive integer greater than 0.

• Value range: Greater than 0.

• Default value: Supported version: v2.4.0

• Default value: 0 Supported version: v2.4.0

• Default value: 18 Supported version: v2.4.0

• Default value: Refer to ZegoSuperBoardCursorTitleStyle class Supported version: v2.4.0

• Value range: Detailed description: Value range: '0' ~ '9', 'a' ~ 'z'. Example: "9dc9a25bh2f2137446897071c8c033fa33b91c3dd2a85e0c000ae82c0dad3". Version 2.3.0 and above appSign allows to pass blank or no pass. If it is empty or not passed, you can pass the token for initialization.please refer to Using Token Authentication.

• Use cases: When the rendering of the file on some iOS mobile devices is abnormal, execute this API to reload the file.
• Required: YES.

• Required: YES.

• When to call /Trigger: After initialization, before creating the file/whiteboard, and after unInit expires.

• When to call /Trigger: After integrating ZegoSuperBoard SDK, before initializing ZegoSuperBoard SDK.

• Use cases: After entering the room, you need to obtain the superBoardSubView list in the room for display, and switch the current superBoardSubView in the list.
• When to call /Trigger: After initializing ZegoSuperboard SDK.

• When to call: this is called when currentSuperBoardSubView exists.

• When to call: this is called when currentSuperBoardSubView exists.

• Use cases: In most scenarios, customers do not need to call this interface, but use the default configuration.
• Default value: local log is error.
• When to call: After initialization, before any other interface.

Usage restrictions: None, but it is recommended to call it only once in the whole life cycle.

Do not call this interface to change the default configuration unless there is a clear special requirement.

• Use cases: Upload files to the ZegoDocs service.
• Caution: There will be multiple callbacks during the upload phase, please refer to the definition of ZegoSuperBoardUploadFileState for details
• When to call /Trigger: After ZegSuperBoard SDK is initialized.

• Use cases: File uploading to the ZegoDocs service is interrupted during the process.

When to call

• Use cases: Save the file to the local directory. You do not need to request the network to open the file next time, which improves the opening speed.
• When to call: You need to call it after initWithConfig.

• Use cases: The cancelCacheFile method can be called to cancel the operation that needs to be interrupted during the execution of the cache file.
• When to call: You need to call it after initWithConfig.
• Related APIs: cacheFile.

• Use cases: None Example Query whether the file cache exists.
• When to call: You need to call it after initWithConfig.
• Related APIs: cancelCacheFile.

• Use cases: Upload custom H5 courseware.
• When to call: You need to call it after the initialization is successful.

• Use cases: Set custom new fonts.
• When to call: This is called after the whiteboard or file has been created.
• Caution: Only specific fonts are supported, and the font files provided by us need to be built into the project, please contact technical support to obtain the font file and the corresponding font name.

• Use cases: Initialize the ZegoSuperBoard SDK.
• When to call: Before calling the ZegoExpressEngine SDK's loginRoom interface
• Related APIs: unInit.

• When to call: Called after initializing the Superboard SDK

• When to call: After initializing the ZegoSuperboard SDK, calling [loginRoom] to log in to the room, when you need to create a pure whiteboard.

• When to call: You need to call it before you check out.

• When to call: When you need to reinitialize the SDK, you must first call unInit.

• Use cases:

1. When the SDK is running, if the developer finds the discrepancy with the expected situation, the developer can submit the problem and related logs to the ZEGO technical personnel for locating the problem. The ZEGO technical personnel may need the SDK version information to assist locating the problem.
2. Developers can also collect this information as the VERSION information of the SDK used by the App, so as to make statistics of the SDK corresponding to each version of the App online.

• When to call: It can be called at any time.

• When to call: After initializing the Superboard SDK, after calling setCustomizedConfig.

• Use cases: Relevant information can be obtained by registering a specified method, for example, by registering for a whiteboard switching notification event, you can listen to the UniqueID of the opposite end to switch the whiteboard in real time.
• When to call: After ZegSuperBoard SDK is initialized.

• When to call: After initializing the ZegoSuperboard SDK and registering the listener event.

• Use cases: SuperBoardView mode is turned on, use the method on the object to switch the whiteboard on the A side, and the B side will automatically synchronize.
• Default value: Get the object by default
• When to call: After initializing ZegoSuperboard SDK.
• Caution: If you use the enableSuperBoardView interface and set it to false, you cannot get the SuperBoardView object.

• Use cases: Synchronize the zooming of the whiteboard on the operating end and the receiving end.
• Default value: When this interface is not called to set the scene, the default configuration is false.
• When to call: After ZegSuperboard SDK is initialized.
• Caution: To achieve dual-ended zoom synchronization, you need to set enableSyncScale and enableResponseScale at the same time
• Related callbacks: scaling changes occur on the peer end, and the receiving end can monitor the changed parameters through remoteSuperBoardScaleChanged.

• Use cases: Synchronize the zooming of the whiteboard on the operating end and the receiving end.
• Default value: When this interface is not called to set the scene, the default configuration is false.
• When to call: After ZegSuperboard SDK is initialized.
• Caution: To achieve dual-ended zoom synchronization, you need to set enableSyncScale and enableResponseScale at the same time
• Related callbacks: scaling changes occur on the peer end, and the receiving end can monitor the changed parameters through remoteSuperBoardScaleChanged.

• Use cases: Adjust the thickness and shape of the strokes according to the speed of the graffiti drawing process to enhance the writing experience.
• Default value: false.
• When to call /Trigger: Initialize the SDK, after rendering the whiteboard.

• When to call: After ZegSuperBoard SDK is initialized.

• Default value: The default value is 1, and the default tool is pen
• When to call: After ZegSuperBoard SDK is initialized.

• When to call: After initializing ZegoSuperBoard SDK.

• Default value: false
• When to call: After ZegSuperBoard SDK is initialized.
• Caution: Only the newly-added text after setting the text bold will have the bold effect. For example, the existing text on the whiteboard will not be changed to the bold effect.

• When to call: After ZegSuperBoard SDK is initialized.

• Default value: false
• When to call: After ZegSuperBoard SDK is initialized.
• Caution: Only the new text after calling will take effect. For example, the existing text on the whiteboard will not be changed.

• When to call: After ZegSuperBoard SDK is initialized.

• Default value: 24, the maximum value shall not exceed 100
• When to call: After ZegSuperBoard SDK is initialized.
• Caution: Only the new text after calling setFontSize will take effect. For example, the existing text on the whiteboard will not be changed to the font size.

• When to call: After ZegSuperBoard SDK is initialized.

• Default value: 6
• When to call: After ZegSuperBoard SDK is initialized.
• Caution: The newly added graffiti after only setting the brush thickness has a new thickness effect. For example, the graffiti on the whiteboard will not be changed to the thickness.

• When to call: After ZegSuperBoard SDK is initialized.

• Default value: #f54326
• When to call: After ZegSuperBoard SDK is initialized.
• Caution: Only the new graffiti after setting the pen color will take effect. If the graffiti already exists on the whiteboard before, it will not be changed to the color.

• When to call: After ZegSuperBoard SDK is initialized.

• When to call: when there are primitives on the whiteboard, it can be used.

• Caution:

1. Each time this interface is called, the entire SubView content will be redrawn, and the position will be adaptive in real time. In order to improve the interactive experience, it can be called with limited frequency.
2. It is only supported to call this API to reload View when the browser zoom is 100%. Otherwise, the file may be displayed abnormally due to the conflict between the adaptive strategy of this API and the adaptive strategy caused by the second zoom of the browsing.

• Use cases: When you need to display the sheet table of the excel file, use this method to get the names of all the sheet tables of the excel file.
• Caution: Return an empty list for non-excel file types.
• When to call: After createFile succeeds or the pull list succeeds.

• Use cases: Display the preview screen of each page of the document
• When to call /Trigger: Called after the file is loaded, otherwise it returns an empty list.

• Use cases: Get the notes of the specified page number of the PPT.
• When to call: After the loadFile succeeds.

• Use cases: Get the ZegoSuperBoardSubViewModel data corresponding to the whiteboard, such as the whiteboard ID, name, associated file ID, current zoom factor, etc.

When to call

• Use cases: Add text to the whiteboard View, and an input box will pop up from the bottom of the whiteboard after calling.
• Default value: The default content of the input box is "text", you can set the default text through [ZegoSuperBoardManager.setCustomText], the default display position is the middle of the current whiteboard range
• When to call: this is called when currentSuperBoardSubView exists.

• Use cases: Whiteboard related operations.
• Related APIs: redo.
• When to call: when currentSuperBoardSubView exists.

• Use cases: Whiteboard related operations.
• Related APIs: undo.
• When to call: this is called when currentSuperBoardSubView exists.

• Use cases: Whiteboard related operations.
• Related APIs: clearAllPage.
• When to call: this is called when currentSuperBoardSubView exists.

• Use cases: Whiteboard related operations.
• Related APIs: clearCurrentPage.
• When to call: this is called when currentSuperBoardSubView exists.

• Use cases: Normally, there is no need to call this method. When the toolType is set, the SDK will call this method to process the whiteboard. If you need to prohibit the client's gesture operation on the whiteboard, you can use this method to set it to None mode.
• Default value: Draw/zoom mode.
• Impacts on other APIs: When set to scroll mode, gestures will be recognized as scrolling, and when set to drawing mode, gestures will be recognized as drawing-related operations at this time.
• Caution: It can be called only when the currentSuperBoardSubView exists. You can use the getCurrentSuperBoardSubView() method to determine whether the currentSuperBoardSubView exists, otherwise it will not have any effect.
• When to call: this is called when currentSuperBoardSubView exists.

• Use cases: Specify a page number to jump.
• Caution: If it is a dynamic ppt or H5 file, the jump page may need to download pictures and animation resources, so frequent calls may cause it to take a long time to complete.
• Related callbacks: scrollChange.
• Related APIs: flipToPrePage，flipToNextPage
• When to call: this is called when currentSuperBoardSubView exists.

• Caution: If it is a dynamic ppt or H5 file, the jump page may need to download pictures and animation resources, so frequent calls may cause it to take a long time to complete.
• Related callbacks: scrollChange.
• Related APIs: flipToPage，flipToNextPage
• When to call: this is called when currentSuperBoardSubView exists.

• Caution: If it is a dynamic ppt or H5 file, the jump page may need to download pictures and animation resources, so frequent calls may cause it to take a long time to complete.
• Related callbacks: scrollChange.
• Related APIs: flipToPage，flipToPrePage
• When to call: this is called when currentSuperBoardSubView exists.

• Caution: Only for dynamic ppt or H5 files, otherwise it will not have any effect.
• Related APIs: nextStep.
• When to call: this is called when currentSuperBoardSubView exists.

• Caution: Only for dynamic ppt or H5 files, otherwise it will not have any effect.
• Related APIs: preStep.
• When to call: this is called when currentSuperBoardSubView exists.

• When to call: When using ZegoSuperBoardView, this is called when currentSuperBoardSubView exists. When not in use ZegoSuperBoardView, when superBoardSubViewModel superBoardSubViewModelList existence can be invoked.

• Use cases: When opening an excel file, the default is the 0th sheet page.
• When to call: this is called when currentSuperBoardSubView exists.

• Caution: If it is not a file whiteboard, 0 will be returned.
• When to call: this is called when currentSuperBoardSubView exists.

• When to call: this is called when currentSuperBoardSubView exists.

• Use cases: After setting the custom graphics, when the whiteboard tool is selected as the custom graphics, touching the whiteboard will draw the custom graphics passed in here.
• Caution: Supported image types: png/jpg/jpeg, when the type is ZegoWhiteboardViewImageGraphic, it supports local images and network images, and the image size limit is 10M. When the type is ZegoWhiteboardViewImageCustom, only network images are supported, and the image size limit is 500KB.
• Related callbacks: IZegoSuperBoardApiCalledCallback.
• When to call: this is called when currentSuperBoardSubView exists.

• When to call: After getting the SuperBoardSubView list.

• When to call: After Get the SuperBoardSubView list.

• When to call: Get the SuperBoardSubView list.

• When to call: Called during audio and video playback after the file has been successfully loaded.

• Default value: rgb(241, 243, 244)
• When to call: After ZegSuperBoard SDK is initialized.
• Caution: 1. Since the whiteboard is overlaid on the file, setting the background color of the whiteboard will obscure the file. 2. After setting the whiteboard background color, all whiteboard background colors in the room will take effect

• When to call: After ZegSuperBoard SDK is initialized.
• Caution: Effective when the superBoardView mode is turned on.

• Value range: Greater than 0

• Value range: Greater than 0

• Required: optional parameters