Class

2026-01-16


ZegoCreateFileConfig	ZegoCreateWhiteboardConfig
ZegoSuperBoardCursorAttribute	ZegoSuperBoardCursorTitleStyle
ZegoSuperBoardInitConfig	ZegoSuperBoardManager
ZegoSuperBoardManager+File	ZegoSuperBoardManager+WhiteBoard
ZegoSuperBoardSubView	ZegoSuperBoardSubViewModel
ZegoSuperBoardView	ZegoUploadCustomH5Config

ZegoCreateFileConfig

详情

接口参数构造类，用传入创建文件所需要的参数。

业务场景：在调用[createFileView]接口时需要传入。

Declared in ZegoCreateFileConfig.h

属性

fileID

nonatomic,copy NSString * fileID

文件对应的ID

是否必填：必填

支持版本：2.0.0及以上

ZegoCreateWhiteboardConfig

详情

接口参数构造类，用传入创建白板所需要的参数。

业务场景：在调用 createWhiteboardView 接口是需要传入。

Declared in ZegoCreateWhiteboardConfig.h

属性

name

nonatomic,copy NSString * name

创建白板时需要设置的白板名称。

是否必填：必填
取值范围：限制长度为 128 字节，支持中英文。

支持版本：2.0.0及以上

perPageWidth

nonatomic,assign NSInteger perPageWidth

每页白板的宽度。

是否必填：必填
取值范围：大于 0 的正整数。

支持版本：v2.0.0。

perPageHeight

nonatomic,assign NSInteger perPageHeight

每页白板的高度。

是否必填：必填
取值范围：大于0 的正整数。

支持版本：2.0.0及以上

pageCount

nonatomic,assign NSInteger pageCount

总页数。

是否必填：必填。
取值范围：大于0。

支持版本：2.0.0及以上

ZegoSuperBoardCursorAttribute

详情

接口参数构造类，用传入光标样式所需要的参数。

业务场景：在调用[setCustomCursorAttribute:cursorAttribute:complete:]接口时需要传入。

Declared in ZegoSuperBoardCursorAttribute.h

属性

iconPath

nonatomic, copy NSString * iconPath

自定义光标图片路径, 本地路径或者网络路径均可（网络图片仅支持 https，图片格式只支持png。）例："xxxxxxxxxx.png"，""

是否必填：否
默认值：

支持版本：v2.4.0

offsetX

nonatomic, assign CGFloat offsetX

自定义光标作用点，绘制点作用在图片指定x偏移方向，默认为0，不可超出图片宽度

是否必填：否
默认值：0

支持版本：v2.4.0

offsetY

nonatomic, assign CGFloat offsetY

自定义光标作用点，绘制点作用在图片指定y偏移方向,默认为0，不可超出图片高度

是否必填：否
默认值：0

支持版本：v2.4.0

titleStyle

nonatomic, strong ZegoSuperBoardCursorTitleStyle titleStyle

光标自定义文字信息

是否必填：否
默认值：参考ZegoSuperBoardCursorTitleStyle类

支持版本：v2.4.0

ZegoSuperBoardCursorTitleStyle

光标自定义文本信息

详情

设置光标自定义文本信息

业务场景：需要显示光标自定义文本时可用

Declared in ZegoSuperBoardCursorTitlePosition.h

属性

title

nonatomic, copy NSString * title

光标自定义文字内容

是否必填：否
默认值：“”
建议值：用户登录名字展示
取值范围：15个字符以内

bold

nonatomic, assign BOOL bold

光标自定义文本是否加粗

是否必填：否
默认值：false

italic

nonatomic, assign BOOL italic

光标自定义文本是否斜体

是否必填：否
默认值：false

size

nonatomic, assign int size

光标自定义文本字体大小

是否必填：否
默认值：16
取值范围：12-20

color

nonatomic, strong int color

光标自定义文本字体颜色

是否必填：否
默认值：白色

backgroundColor

nonatomic, strong int backgroundColor

光标自定义文本字体背景颜色

是否必填：否

position

nonatomic, assign ZegoSuperBoardCursorTitlePosition position

自定义文本相对于光标的位置

是否必填：否

ZegoSuperBoardInitConfig

详情

接口参数构造类，用构造初始化SDK所需要的参数。

业务场景：调用初始化SDK接口 initWithConfig 时需要传入。

Declared in ZegoSuperBoardInitConfig.h

属性

appID

nonatomic,assign long appID

ZEGO 为开发者签发的应用 ID，请从 ZEGO 管理控制台申请。

是否必填：必填
取值范围：0 - 4294967295。

token

nonatomic,copy NSString * token

登录验证 token，是通过在即构控制台注册项目获得密钥，加上指定算法获得。测试阶段可以通过 ZEGO 提供的接口获取，正式环境一定要用户自己实现。

userID

public NSString * userID

用户ID，请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

appSign

public NSString * appSign

取值范围：'0' ~ '9', 'a' ~ 'z'。例："9dc9a25bh2f2137446897071c8c033fa33b91c3dd2a85e0c000ae82c0dad3"。2.3.0及以上版本 appSign 允许传空或者不传。如果传空或者不传，可以传token进行初始化。token的生成方式请参考使用 Token 鉴权。

cacheFolder

public NSString * cacheFolder

缓存目录

logFolder

public NSString * logFolder

日志目录

ZegoSuperBoardManager+File

属性

toolType

nonatomic,assign,readwrite ZegoSuperBoardTool toolType

设置不一样的工具类型可以在白板上绘制不一样的图元。

调用时机：初始化 ZegSuperBoard SDK 之后。

支持版本：2.0.0 及以上。

brushColor

nonatomic,strong, readwrite UIColor * brushColor

选择了画笔工具类型，设置 brushColor 之后，白板上新增的涂鸦颜色会改变。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：仅设置画笔颜色之后新增的涂鸦生效，如之前白板上已存在涂鸦不会更改颜色。

brushSize

nonatomic,assign, readwrite NSUInteger brushSize

选择了画笔工具类型，设置 brushSize 之后，白板上新增的画笔粗细会改变。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：仅设置画笔粗细之后新增的涂鸦生效，如之前白板上已存在涂鸦不会更改粗细。

isFontBold

nonatomic,assign, readwrite BOOL isFontBold

选择了文字工具类型，调用 isFontBold 设置为 YES之后，在白板上新增的文字都是粗体效果。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：仅设置文本粗体之后新增的文字拥有粗体效果，如之前白板上已存在文字不会更改为粗体效果。

isFontItalic

nonatomic, assign, readwrite BOOL isFontItalic

当前使用工具类型为文本时，调用 isFontItalic 可设置斜体效果。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：仅设置文本斜体之后新增的文字拥有斜体效果，如之前白板上已存在文字不会更改为斜体效果。

customText

nonatomic, copy, readwrite NSString * customText

用户可自定义文本工具的默认文本.

支持版本：2.0.0 及以上。

enableSyncScale

nonatomic, assign, readwrite BOOL enableSyncScale

开启之后，可以将本端缩放的事件同步出去，对端是否响应决定于对端是否开启接受缩放。

业务场景：使操作端和接受端的白板缩放同步。
调用时机：初始化 ZegSuperboard SDK 之后。
相关回调：对端发生缩放变化，接受端可通过 remoteSuperBoardScaleChanged 监听变化参数。

支持版本：2.0.0 及以上。
注意事项：如需实现双端缩放同步，需要同时设置 enableSyncScale 和 enableResponseScale

enableResponseScale

nonatomic, assign, readwrite BOOL enableResponseScale

开启之后，可以响应房间内其他成员的缩放，前提是对端将缩放同步给房间内其他成员。

业务场景：使操作端和接受端的白板缩放同步。
调用时机：初始化 ZegSuperboard SDK 之后。
相关回调：对端发生缩放变化，接受端可通过 remoteSuperBoardScaleChanged 监听变化参数。

支持版本：2.0.0 及以上。
注意事项：如需实现双端缩放同步，需要同时设置 enableSyncScale 和 enableResponseScale

enableHandwriting

nonatomic, assign, readwrite BOOL enableHandwriting

设置白板涂鸦是否拥有笔锋效果，设置为 true 则该涂鸦带有笔锋效果。

业务场景：根据涂鸦绘制过程中的速度调整笔画粗细和形状，增强书写体验。
调用时机：初始化 SDK 之后。

支持版本：2.0.0 及以上。

delegate

nonatomic, weak id<ZegoSuperBoardManagerDelegate> delegate

设置SuperBoardManager的代理者,可以实现对应的代理方法来监听SDK内superBoardSubView的新增、销毁、切换、SDK的异常等。

业务场景：需要在superBoardSubView的新增、销毁、切换等情况下，对界面做出更新。

支持版本：2.0.0 及以上。

superBoardView

nonatomic, strong,readonly ZegoSuperBoardView * superBoardView

开启 SuperBoardView 模式时，获取该对象。

业务场景：在开启 SuperBoardView 模式下，使用该对象上的方法进行 A 端切换白板，B 端自动同步。
默认值：默认获得该对象。
调用时机：初始化 ZegoSuperboard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：如果使用 enableSuperBoardView 接口并设置为 false ，则无法获取 SuperBoardView 对象。

superBoardSubViewModelList

nonatomic, strong,readonly NSArray <ZegoSuperBoardSubViewModel *> * superBoardSubViewModelList

通过superBoardSubViewModelList,可以获取到当前房间内存在的superBoardSubView的数量以及superBoardSubView的信息。

业务场景：进房后需要获取房间内的superBoardSubView列表做展示，在列表中切换当前展示的superBoardSubView。
调用时机：初始化 ZegoSuperboard SDK 之后。

支持版本：2.0.0 及以上。

enableCustomCursor

nonatomic, assign, readwrite BOOL enableCustomCursor

设置是否启用自定义光标，设置为 true 则显示光标。默认为true

业务场景：涂鸦过程中显示光标功能。
调用时机：初始化 SDK 之后。

支持版本：v2.2.0

enableRemoteCursorVisible

nonatomic, assign, readwrite BOOL enableRemoteCursorVisible

设置是否是否显示远端光标，设置为 true 则显示远端的光标。默认为true。

业务场景：涂鸦过程中显示远端光标功能。
调用时机：初始化 SDK 之后。

支持版本：v2.2.0

superBoardMaxScaleFactor

nonatomic, assign, readwrite CGFloat superBoardMaxScaleFactor

调用时机：请在初始化之后，创建文件/白板之前，unInit之后失效。

方法

sharedInstance

static

sharedInstance

+ (ZegoSuperBoardManager *)sharedInstance;

获取 ZegoSuperBoardManager 实例对象。

获取 ZegoSuperBoardManager 实例对象才能调用 ZegoSuperBoardManager 中的接口方法。

调用时机：集成 ZegoSuperBoard SDK之后，初始化 ZegoSuperBoard SDK 之前。

支持版本：2.0.0 及以上。

ZegoSuperBoardManager 实例对象

uploadFile:filePath:renderType:completionBlock:

- (ZegoSuperBoardSeq)uploadFile:(nonnull NSString *) filePath renderType:(ZegoSuperBoardRenderType) renderType completionBlock:(nonnull ZegoSuperBoardUploadBlock) completionBlock;

上传文件到 ZegoSuperBoard 服务

参数

名称	类型	描述
filePath	nonnull NSString *	需要上传的文件绝对路径，支持 ppt、pdf、xls、jpg、jpeg、png、bmp、txt 等类型的文件，具体参考文件规范。
renderType	ZegoSuperBoardRenderType	上传文件转码后的渲染模式类型，建议设置为 ZegoSuperBoardRenderTypeVectorAndIMG，详见 ZegoSuperBoardRenderType。
completionBlock	nonnull ZegoSuperBoardUploadBlock	上传的进度和结果的回调。上传文件的过程中，会在 [completionBlock] 内收到多次回调，具体请查看 ZegoSuperBoardUploadBlock 的介绍

详情

上传过程中，SDK 会根据传入的 [renderType] 对文件进行格式转换，格式转换后文件的渲染模式取决于传入的 [renderType]，可在结果回调中获取上传的进度信息。

业务场景：上传文件到ZegoDocs 服务。
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：上传阶段会有多次回调，详细请查阅 ZegoSuperBoardUploadFileState 定义

返回值

返回上传文件的请求 seq

cancelUploadFileWithSeq:seq:completionBlock:

- (void)cancelUploadFileWithSeq:(ZegoSuperBoardSeq) seq completionBlock:(ZegoSuperBoardCancelUploadComplementBlock) completionBlock;

在上传文件的过程中取消上传动作

参数

名称	类型	描述
seq	ZegoSuperBoardSeq	调用uploadFile时返回的上传seq。
completionBlock	ZegoSuperBoardCancelUploadComplementBlock	取消上传文件结果回调。

详情

执行取消上传文件的操作必须传入对应的上传任务的seq。

业务场景：在上传文件的过程中需要中断对应文件的上传到ZegoDocs service。
调用时机：调用uploadFile接口后正在上传文件过程中的时候调用。

支持版本：2.0.0 及以上。

cacheFileWithFileID:fileID:completionBlock:

- (ZegoSuperBoardSeq)cacheFileWithFileID:(nonnull NSString *) fileID completionBlock:(ZegoSuperBoardCacheBlock) completionBlock;

将文件缓存到本地

参数

名称	类型	描述
fileID	nonnull NSString *	需要缓存的文件 ID
completionBlock	ZegoSuperBoardCacheBlock	下载文件进度和结果回调

详情

可以把对应文件保存到本地。

业务场景：把文件保存到本地，下次打开不需要请求网络，提升打开速度。
调用时机：需要在 initWithConfig 之后调用。

支持版本：2.0.0 及以上。

返回值

下载文件操作对应的序列号

cancelCacheFileWithSeq:seq:completionBlock:

- (void)cancelCacheFileWithSeq:(ZegoSuperBoardSeq) seq completionBlock:(ZegoSuperBoardCancelCacheComplementBlock) completionBlock;

在缓存文件的过程中取消缓存动作

参数

名称	类型	描述
seq	ZegoSuperBoardSeq	缓存操作的序列号。
completionBlock	ZegoSuperBoardCancelCacheComplementBlock	取消缓存操作结果回调。

详情

可以取消掉正在缓存文件的操作，需要传入对应缓存文件操作的seq，取消后文件不会被缓存到本地。

业务场景：在执行缓存文件过程中，需要中断当前缓存文件的操作，可以调用cancelCacheFile方法来取消掉对应的操作。
调用时机：需要在 initWithConfig 之后调用。
相关接口：cacheFile。

支持版本：2.0.0 及以上。

返回值

操作结果

queryFileCachedWithFileID:fileID:completionBlock:

- (void)queryFileCachedWithFileID:(nonnull NSString *) fileID completionBlock:(ZegoSuperBoardQueryCachedCompletionBlock) completionBlock;

查询文件缓存是否存在

参数

名称	类型	描述
fileID	nonnull NSString *	待查询的文件ID。
completionBlock	ZegoSuperBoardQueryCachedCompletionBlock	查询结果回调。

详情

通过对应文件的ID可以查找到该文件是否本地已经缓存下来了。

业务场景：查询文件缓存是否存在。
调用时机：需要在 initWithConfig 之后调用。
相关接口：cacheFile。

支持版本：2.0.0 及以上。

uploadH5File:filePath:config:completionBlock:

- (ZegoSuperBoardSeq)uploadH5File:(nonnull NSString *) filePath config:(ZegoUploadCustomH5Config *) config completionBlock:(ZegoSuperBoardUploadBlock) completionBlock;

上传自定义H5课件

参数

名称	类型	描述
filePath	nonnull NSString *	自定义课件的本地路径
config	ZegoUploadCustomH5Config *	自定义H5课件相关配置信息
completionBlock	ZegoSuperBoardUploadBlock	结果回调

详情

上传过程中，SDK 会根据传入的 [config] 对文件进行格式转换，格式转换后文件的宽高页码以及是否带缩略图取决于传入的 [config]，可在结果回调中获取上传的进度信息。

业务场景：上传自定义H5课件。
调用时机：您需要在初始化成功后调用它。

支持版本：2.0.0 及以上。

返回值

返回上传接口请求的seq

setSuperBoardMaxScaleFactor:scaleFactor:

- (void)setSuperBoardMaxScaleFactor:(Float) scaleFactor;

设置超级白板（文件和白板）最大缩放倍数，默认为3倍。可设置的区间为【1,10】

参数

名称	类型	描述
scaleFactor	Float	详情描述：超级白板（文件和白板）最大缩放倍数

详情

设置超级白板（文件和白板）最大缩放倍数，默认为3倍。可设置的区间为【1,10】

调用时机/通知时机：请在初始化之后，创建文件/白板之前，unInit之后失效。

支持版本：2.3.7

renewToken:token:

- (void)renewToken:(NSString *) token;

更新Token

参数

名称	类型	描述
token	NSString *	需要更新的 Token。

详情

token 权限变更、或者 token 过期时调用，用于更新 token 权限

默认值：无
调用时机：初始化 SDK 后，借助 ZEGO SDK 的将要过期回调 [tokenWillExpire] 接口，收到 token 将要过期回调，主动更新超级白板的文件服务 token。
影响范围：token 内包含的过期时间，在过期前 30s 会触发 [tokenWillExpire] 回调
相关回调：无
相关接口：[tokenWillExpire]
平台差异：无

setManagerListener:listener:

- (void)setManagerListener:(ZegoSuperBoardManagerDelegate) listener;

设置SDK方法监听

参数

名称	类型	描述
listener	ZegoSuperBoardManagerDelegate	监听白板回调信息

调用时机：init之后

支持版本：2.0.0及以上

initWithConfig:config:complete:

- (void)initWithConfig:(ZegoSuperBoardInitConfig *) config complete:(ZegoSuperBoardManagerBlock) complete;

初始化 ZegoSuperBoard SDK

参数

名称	类型	描述
config	ZegoSuperBoardInitConfig *	SDK 初始化所需要的配置信息
complete	ZegoSuperBoardManagerBlock	初始化的结果回调

详情

初始化ZegoSuperBoard SDK的方法。

业务场景：初始化 ZegoSuperBoard SDK。
调用时机：在调用ZegoExpressEngine SDK的loginRoom接口前。
相关接口：unInit。

支持版本：2.0.0 及以上。

setCustomizedConfig:value:key:

- (void)setCustomizedConfig:(nonnull NSString *) value key:(nonnull NSString *) key;

设置配置项 例如： key值为 logPath，SDK记录日志的目录地址。 key值为 cachePath，SDK缓存的目录地址。

参数

名称	类型	描述
value	nonnull NSString *	value 描述
key	nonnull NSString *	key 描述

调用时机：初始化 Superboard SDK 后调用

支持版本：2.0.0 及以上。

返回值

设置是否成功

enableSuperBoardView:enable:

- (void)enableSuperBoardView:(BOOL) enable;

设置是否使用 SuperBoardView

参数

名称	类型	描述
enable	BOOL	YES 代表使用SuperBoardView NO代表不使用, 默认为YES

详情

设置是否使用 SuperBoardView。

调用时机：初始化 SDK 之前。

支持版本：2.0.0 及以上。
注意事项：默认开启

createWhiteboardView:config:complete:

- (void)createWhiteboardView:(nonnull ZegoCreateWhiteboardConfig *) config complete:(ZegoSuperBoardManagerCreateBlock) complete;

创建纯白板

参数

名称	类型	描述
config	nonnull ZegoCreateWhiteboardConfig *	纯白板相关的配置参数
complete	ZegoSuperBoardManagerCreateBlock	创建纯白板的结果回调

详情

创建成功后会内部保存对应的SubView并返回它的 subViewModel 数据

调用时机：初始化 ZegoSuperboard SDK，调用 [loginRoom] 登录房间之后，需要创建纯白板的时候。

支持版本：2.0.0 及以上。

createFileView:config:complete:

- (void)createFileView:(nonnull ZegoCreateFileConfig *) config complete:(ZegoSuperBoardManagerCreateBlock) complete;

创建文件

参数

名称	类型	描述
config	nonnull ZegoCreateFileConfig *	创建文件需要的配置参数
complete	ZegoSuperBoardManagerCreateBlock	创建文件的结果回调

详情

创建成功后会内部保存对应的SubView并返回它的 subViewModel 数据

调用时机：初始化 ZegoSuperboard SDK，调用 [loginRoom] 登录房间之后，需要创建文件的时候。

支持版本：2.0.0 及以上。

destroySuperBoardSubView:uniqueID:complete:

- (void)destroySuperBoardSubView:(NSString *) uniqueID complete:(ZegoSuperBoardManagerBlock) complete;

销毁指定的 SuperBoardSubView 视图

参数

名称	类型	描述
uniqueID	NSString *	ZegoSuperBoardSubView 对象的唯一标识
complete	ZegoSuperBoardManagerBlock	销毁指定SuperBoardSubView的结果回调

调用时机：在调用querySuperBoardSubViewList 拉取到列表后或者 superBoardSubViewModelList 获取到model数量大于0的时候调用。

支持版本：2.0.0 及以上。

querySuperBoardSubViewList:complete:

- (void)querySuperBoardSubViewList:(void(^)(ZegoSuperBoardError errorCode,NSArray <ZegoSuperBoardSubViewModel *>*superBoardViewList)) complete;

向服务器查询当前存在的 SuperBoardSubView 列表

参数

名称	类型	描述
complete	void(^)(ZegoSuperBoardError errorCode,NSArray <ZegoSuperBoardSubViewModel >superBoardViewList)	获取SuperBoardSubView列表的结果回调

详情

将当前房间内的白板一次性拉取下来，SDK内部会将关联了文件的白板中的文件也加载下来，这些白板和文件SDK内部会处理对应关系添加到ZegoSuperBoardSubView中，外部只需要使用ZegoSuperBoardView即可。

调用时机：初始化SDK，登录房间之后调用。

支持版本：2.0.0及以上

getSuperBoardSubView:uniqueID:

- (ZegoSuperBoardSubView *)getSuperBoardSubView:(NSString *) uniqueID;

获取指定的 SuperBoardSubView

参数

名称	类型	描述
uniqueID	NSString *	ZegoSuperBoardSubView 对象的唯一标识

调用时机：初始化SDK，进房成功后，获取到SuperBoardSubView列表之后调用。

支持版本：2.0.0及以上
注意事项：仅限于不使用 SuperBoardView （通过 enableSuperBoardView 设置）的场景使用

clearCache

- (void)clearCache;

清除文件和白板相关的缓存资源

调用时机：初始化，进入房间之后，SDK 对于房间内资源的清理，需要在退出房间前主动调用。

支持版本：2.0.0及以上

clear

- (void)clear;

清空房间内资源退房时调用

退房时需要清空房间内的缓存信息，以及停止媒体播放。

调用时机：需要在退房前主动调用。

支持版本：2.0.0及以上

unInit

- (void)unInit;

反初始化SDK

调用时机：当你需要重新初始化SDK时，你必须先调用unInit。

支持版本：2.0.0及以上

getSDKVersion

- (NSString *)getSDKVersion;

获取SDK的版本号

获取 SDK 版本号。

业务场景：1. SDK 在运行过程中，当开发者发现与预期情况不符时，可将问题与相关日志提交给 ZEGO 技术人员定位，ZEGO 技术人员可能需要 SDK 的版本的信息来辅助定位问题。

开发者也可以收集此信息作为 App 所使用的 SDK 的版本信息，以便统计线上各版本 App 对应的各版本 SDK。

调用时机：在任意时刻均可调用。

支持版本：v2.0.0 及以上。

SDK的版本号

getCustomizedConfig:key:

- (NSString *)getCustomizedConfig:(nonnull NSString *) key;

获取设置的配置项的值

参数

名称	类型	描述
key	nonnull NSString *	要获取的设置项

详情

获取设置的配置项的值。

调用时机：初始化 Superboard SDK，调用 setCustomizedConfig 之后。

支持版本：2.0.0及以上。

ZegoSuperBoardManager+WhiteBoard

属性

toolType

nonatomic,assign,readwrite ZegoSuperBoardTool toolType

设置不一样的工具类型可以在白板上绘制不一样的图元。

调用时机：初始化 ZegSuperBoard SDK 之后。

支持版本：2.0.0 及以上。

brushColor

nonatomic,strong, readwrite UIColor * brushColor

选择了画笔工具类型，设置 brushColor 之后，白板上新增的涂鸦颜色会改变。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：仅设置画笔颜色之后新增的涂鸦生效，如之前白板上已存在涂鸦不会更改颜色。

brushSize

nonatomic,assign, readwrite NSUInteger brushSize

选择了画笔工具类型，设置 brushSize 之后，白板上新增的画笔粗细会改变。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：仅设置画笔粗细之后新增的涂鸦生效，如之前白板上已存在涂鸦不会更改粗细。

isFontBold

nonatomic,assign, readwrite BOOL isFontBold

选择了文字工具类型，调用 isFontBold 设置为 YES之后，在白板上新增的文字都是粗体效果。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：仅设置文本粗体之后新增的文字拥有粗体效果，如之前白板上已存在文字不会更改为粗体效果。

isFontItalic

nonatomic, assign, readwrite BOOL isFontItalic

当前使用工具类型为文本时，调用 isFontItalic 可设置斜体效果。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：仅设置文本斜体之后新增的文字拥有斜体效果，如之前白板上已存在文字不会更改为斜体效果。

customText

nonatomic, copy, readwrite NSString * customText

用户可自定义文本工具的默认文本.

支持版本：2.0.0 及以上。

enableSyncScale

nonatomic, assign, readwrite BOOL enableSyncScale

开启之后，可以将本端缩放的事件同步出去，对端是否响应决定于对端是否开启接受缩放。

业务场景：使操作端和接受端的白板缩放同步。
调用时机：初始化 ZegSuperboard SDK 之后。
相关回调：对端发生缩放变化，接受端可通过 remoteSuperBoardScaleChanged 监听变化参数。

支持版本：2.0.0 及以上。
注意事项：如需实现双端缩放同步，需要同时设置 enableSyncScale 和 enableResponseScale

enableResponseScale

nonatomic, assign, readwrite BOOL enableResponseScale

开启之后，可以响应房间内其他成员的缩放，前提是对端将缩放同步给房间内其他成员。

业务场景：使操作端和接受端的白板缩放同步。
调用时机：初始化 ZegSuperboard SDK 之后。
相关回调：对端发生缩放变化，接受端可通过 remoteSuperBoardScaleChanged 监听变化参数。

支持版本：2.0.0 及以上。
注意事项：如需实现双端缩放同步，需要同时设置 enableSyncScale 和 enableResponseScale

enableHandwriting

nonatomic, assign, readwrite BOOL enableHandwriting

设置白板涂鸦是否拥有笔锋效果，设置为 true 则该涂鸦带有笔锋效果。

业务场景：根据涂鸦绘制过程中的速度调整笔画粗细和形状，增强书写体验。
调用时机：初始化 SDK 之后。

支持版本：2.0.0 及以上。

delegate

nonatomic, weak id<ZegoSuperBoardManagerDelegate> delegate

设置SuperBoardManager的代理者,可以实现对应的代理方法来监听SDK内superBoardSubView的新增、销毁、切换、SDK的异常等。

业务场景：需要在superBoardSubView的新增、销毁、切换等情况下，对界面做出更新。

支持版本：2.0.0 及以上。

superBoardView

nonatomic, strong,readonly ZegoSuperBoardView * superBoardView

开启 SuperBoardView 模式时，获取该对象。

业务场景：在开启 SuperBoardView 模式下，使用该对象上的方法进行 A 端切换白板，B 端自动同步。
默认值：默认获得该对象。
调用时机：初始化 ZegoSuperboard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：如果使用 enableSuperBoardView 接口并设置为 false ，则无法获取 SuperBoardView 对象。

superBoardSubViewModelList

nonatomic, strong,readonly NSArray <ZegoSuperBoardSubViewModel *> * superBoardSubViewModelList

通过superBoardSubViewModelList,可以获取到当前房间内存在的superBoardSubView的数量以及superBoardSubView的信息。

业务场景：进房后需要获取房间内的superBoardSubView列表做展示，在列表中切换当前展示的superBoardSubView。
调用时机：初始化 ZegoSuperboard SDK 之后。

支持版本：2.0.0 及以上。

enableCustomCursor

nonatomic, assign, readwrite BOOL enableCustomCursor

设置是否启用自定义光标，设置为 true 则显示光标。默认为true

业务场景：涂鸦过程中显示光标功能。
调用时机：初始化 SDK 之后。

支持版本：v2.2.0

enableRemoteCursorVisible

nonatomic, assign, readwrite BOOL enableRemoteCursorVisible

设置是否是否显示远端光标，设置为 true 则显示远端的光标。默认为true。

业务场景：涂鸦过程中显示远端光标功能。
调用时机：初始化 SDK 之后。

支持版本：v2.2.0

superBoardMaxScaleFactor

nonatomic, assign, readwrite CGFloat superBoardMaxScaleFactor

调用时机：请在初始化之后，创建文件/白板之前，unInit之后失效。

方法

sharedInstance

static

sharedInstance

+ (ZegoSuperBoardManager *)sharedInstance;

获取 ZegoSuperBoardManager 实例对象。

获取 ZegoSuperBoardManager 实例对象才能调用 ZegoSuperBoardManager 中的接口方法。

调用时机：集成 ZegoSuperBoard SDK之后，初始化 ZegoSuperBoard SDK 之前。

支持版本：2.0.0 及以上。

ZegoSuperBoardManager 实例对象

setCustomFontWithName:regularFontName:boldFontName:

- (void)setCustomFontWithName:(NSString *) regularFontName boldFontName:(NSString *) boldFontName;

设置自定义新字体

参数

名称	类型	描述
regularFontName	NSString *	常规字体的字体名称，请联系技术支持获取
boldFontName	NSString *	粗体字体的字体名称，请联系技术支持获取

详情

需要给白板中的文本工具设置新的自定义字体样式。

业务场景：设置自定义新字体。
调用时机：需要在创建纯白板或者文件白板完成之后调用。

支持版本：2.0.0 及以上。
注意事项：只支持特定的字体, 并且需要在工程中内置我们提供的字体文件，请联系技术支持获取字体文件与对应的字体名。

setSuperBoardMaxScaleFactor:scaleFactor:

- (void)setSuperBoardMaxScaleFactor:(Float) scaleFactor;

设置超级白板（文件和白板）最大缩放倍数，默认为3倍。可设置的区间为【1,10】

参数

名称	类型	描述
scaleFactor	Float	详情描述：超级白板（文件和白板）最大缩放倍数

详情

设置超级白板（文件和白板）最大缩放倍数，默认为3倍。可设置的区间为【1,10】

调用时机/通知时机：请在初始化之后，创建文件/白板之前，unInit之后失效。

支持版本：2.3.7

renewToken:token:

- (void)renewToken:(NSString *) token;

更新Token

参数

名称	类型	描述
token	NSString *	需要更新的 Token。

详情

token 权限变更、或者 token 过期时调用，用于更新 token 权限

默认值：无
调用时机：初始化 SDK 后，借助 ZEGO SDK 的将要过期回调 [tokenWillExpire] 接口，收到 token 将要过期回调，主动更新超级白板的文件服务 token。
影响范围：token 内包含的过期时间，在过期前 30s 会触发 [tokenWillExpire] 回调
相关回调：无
相关接口：[tokenWillExpire]
平台差异：无

setManagerListener:listener:

- (void)setManagerListener:(ZegoSuperBoardManagerDelegate) listener;

设置SDK方法监听

参数

名称	类型	描述
listener	ZegoSuperBoardManagerDelegate	监听白板回调信息

调用时机：init之后

支持版本：2.0.0及以上

initWithConfig:config:complete:

- (void)initWithConfig:(ZegoSuperBoardInitConfig *) config complete:(ZegoSuperBoardManagerBlock) complete;

初始化 ZegoSuperBoard SDK

参数

名称	类型	描述
config	ZegoSuperBoardInitConfig *	SDK 初始化所需要的配置信息
complete	ZegoSuperBoardManagerBlock	初始化的结果回调

详情

初始化ZegoSuperBoard SDK的方法。

业务场景：初始化 ZegoSuperBoard SDK。
调用时机：在调用ZegoExpressEngine SDK的loginRoom接口前。
相关接口：unInit。

支持版本：2.0.0 及以上。

setCustomizedConfig:value:key:

- (void)setCustomizedConfig:(nonnull NSString *) value key:(nonnull NSString *) key;

设置配置项 例如： key值为 logPath，SDK记录日志的目录地址。 key值为 cachePath，SDK缓存的目录地址。

参数

名称	类型	描述
value	nonnull NSString *	value 描述
key	nonnull NSString *	key 描述

调用时机：初始化 Superboard SDK 后调用

支持版本：2.0.0 及以上。

返回值

设置是否成功

enableSuperBoardView:enable:

- (void)enableSuperBoardView:(BOOL) enable;

设置是否使用 SuperBoardView

参数

名称	类型	描述
enable	BOOL	YES 代表使用SuperBoardView NO代表不使用, 默认为YES

详情

设置是否使用 SuperBoardView。

调用时机：初始化 SDK 之前。

支持版本：2.0.0 及以上。
注意事项：默认开启

createWhiteboardView:config:complete:

- (void)createWhiteboardView:(nonnull ZegoCreateWhiteboardConfig *) config complete:(ZegoSuperBoardManagerCreateBlock) complete;

创建纯白板

参数

名称	类型	描述
config	nonnull ZegoCreateWhiteboardConfig *	纯白板相关的配置参数
complete	ZegoSuperBoardManagerCreateBlock	创建纯白板的结果回调

详情

创建成功后会内部保存对应的SubView并返回它的 subViewModel 数据

调用时机：初始化 ZegoSuperboard SDK，调用 [loginRoom] 登录房间之后，需要创建纯白板的时候。

支持版本：2.0.0 及以上。

createFileView:config:complete:

- (void)createFileView:(nonnull ZegoCreateFileConfig *) config complete:(ZegoSuperBoardManagerCreateBlock) complete;

创建文件

参数

名称	类型	描述
config	nonnull ZegoCreateFileConfig *	创建文件需要的配置参数
complete	ZegoSuperBoardManagerCreateBlock	创建文件的结果回调

详情

创建成功后会内部保存对应的SubView并返回它的 subViewModel 数据

调用时机：初始化 ZegoSuperboard SDK，调用 [loginRoom] 登录房间之后，需要创建文件的时候。

支持版本：2.0.0 及以上。

destroySuperBoardSubView:uniqueID:complete:

- (void)destroySuperBoardSubView:(NSString *) uniqueID complete:(ZegoSuperBoardManagerBlock) complete;

销毁指定的 SuperBoardSubView 视图

参数

名称	类型	描述
uniqueID	NSString *	ZegoSuperBoardSubView 对象的唯一标识
complete	ZegoSuperBoardManagerBlock	销毁指定SuperBoardSubView的结果回调

调用时机：在调用querySuperBoardSubViewList 拉取到列表后或者 superBoardSubViewModelList 获取到model数量大于0的时候调用。

支持版本：2.0.0 及以上。

querySuperBoardSubViewList:complete:

- (void)querySuperBoardSubViewList:(void(^)(ZegoSuperBoardError errorCode,NSArray <ZegoSuperBoardSubViewModel *>*superBoardViewList)) complete;

向服务器查询当前存在的 SuperBoardSubView 列表

参数

名称	类型	描述
complete	void(^)(ZegoSuperBoardError errorCode,NSArray <ZegoSuperBoardSubViewModel >superBoardViewList)	获取SuperBoardSubView列表的结果回调

详情

调用时机：初始化SDK，登录房间之后调用。

支持版本：2.0.0及以上

getSuperBoardSubView:uniqueID:

- (ZegoSuperBoardSubView *)getSuperBoardSubView:(NSString *) uniqueID;

获取指定的 SuperBoardSubView

参数

名称	类型	描述
uniqueID	NSString *	ZegoSuperBoardSubView 对象的唯一标识

调用时机：初始化SDK，进房成功后，获取到SuperBoardSubView列表之后调用。

支持版本：2.0.0及以上
注意事项：仅限于不使用 SuperBoardView （通过 enableSuperBoardView 设置）的场景使用

clearCache

- (void)clearCache;

清除文件和白板相关的缓存资源

调用时机：初始化，进入房间之后，SDK 对于房间内资源的清理，需要在退出房间前主动调用。

支持版本：2.0.0及以上

clear

- (void)clear;

清空房间内资源退房时调用

退房时需要清空房间内的缓存信息，以及停止媒体播放。

调用时机：需要在退房前主动调用。

支持版本：2.0.0及以上

unInit

- (void)unInit;

反初始化SDK

调用时机：当你需要重新初始化SDK时，你必须先调用unInit。

支持版本：2.0.0及以上

getSDKVersion

- (NSString *)getSDKVersion;

获取SDK的版本号

获取 SDK 版本号。

业务场景：1. SDK 在运行过程中，当开发者发现与预期情况不符时，可将问题与相关日志提交给 ZEGO 技术人员定位，ZEGO 技术人员可能需要 SDK 的版本的信息来辅助定位问题。

开发者也可以收集此信息作为 App 所使用的 SDK 的版本信息，以便统计线上各版本 App 对应的各版本 SDK。

调用时机：在任意时刻均可调用。

支持版本：v2.0.0 及以上。

SDK的版本号

getCustomizedConfig:key:

- (NSString *)getCustomizedConfig:(nonnull NSString *) key;

获取设置的配置项的值

参数

名称	类型	描述
key	nonnull NSString *	要获取的设置项

详情

获取设置的配置项的值。

调用时机：初始化 Superboard SDK，调用 setCustomizedConfig 之后。

支持版本：2.0.0及以上。

ZegoSuperBoardManager

详情

接口类，SDK的初始化，房间内全局性的功能设置, 创建文件或者纯白板等。

业务场景：主要用于初始化SDK，设置白板的一些工具、缩放同步、画笔效果，在开启SuperBoardView模式下,获取SuperBoardView, 创建纯白板、文件等。
平台差异：无。

Declared in ZegoSuperBoardManager.h

属性

toolType

nonatomic,assign,readwrite ZegoSuperBoardTool toolType

设置不一样的工具类型可以在白板上绘制不一样的图元。

调用时机：初始化 ZegSuperBoard SDK 之后。

支持版本：2.0.0 及以上。

brushColor

nonatomic,strong, readwrite UIColor * brushColor

选择了画笔工具类型，设置 brushColor 之后，白板上新增的涂鸦颜色会改变。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：仅设置画笔颜色之后新增的涂鸦生效，如之前白板上已存在涂鸦不会更改颜色。

brushSize

nonatomic,assign, readwrite NSUInteger brushSize

选择了画笔工具类型，设置 brushSize 之后，白板上新增的画笔粗细会改变。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：仅设置画笔粗细之后新增的涂鸦生效，如之前白板上已存在涂鸦不会更改粗细。

isFontBold

nonatomic,assign, readwrite BOOL isFontBold

选择了文字工具类型，调用 isFontBold 设置为 YES之后，在白板上新增的文字都是粗体效果。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：仅设置文本粗体之后新增的文字拥有粗体效果，如之前白板上已存在文字不会更改为粗体效果。

isFontItalic

nonatomic, assign, readwrite BOOL isFontItalic

当前使用工具类型为文本时，调用 isFontItalic 可设置斜体效果。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：仅设置文本斜体之后新增的文字拥有斜体效果，如之前白板上已存在文字不会更改为斜体效果。

customText

nonatomic, copy, readwrite NSString * customText

用户可自定义文本工具的默认文本.

支持版本：2.0.0 及以上。

enableSyncScale

nonatomic, assign, readwrite BOOL enableSyncScale

开启之后，可以将本端缩放的事件同步出去，对端是否响应决定于对端是否开启接受缩放。

业务场景：使操作端和接受端的白板缩放同步。
调用时机：初始化 ZegSuperboard SDK 之后。
相关回调：对端发生缩放变化，接受端可通过 remoteSuperBoardScaleChanged 监听变化参数。

支持版本：2.0.0 及以上。
注意事项：如需实现双端缩放同步，需要同时设置 enableSyncScale 和 enableResponseScale

enableResponseScale

nonatomic, assign, readwrite BOOL enableResponseScale

开启之后，可以响应房间内其他成员的缩放，前提是对端将缩放同步给房间内其他成员。

业务场景：使操作端和接受端的白板缩放同步。
调用时机：初始化 ZegSuperboard SDK 之后。
相关回调：对端发生缩放变化，接受端可通过 remoteSuperBoardScaleChanged 监听变化参数。

支持版本：2.0.0 及以上。
注意事项：如需实现双端缩放同步，需要同时设置 enableSyncScale 和 enableResponseScale

enableHandwriting

nonatomic, assign, readwrite BOOL enableHandwriting

设置白板涂鸦是否拥有笔锋效果，设置为 true 则该涂鸦带有笔锋效果。

业务场景：根据涂鸦绘制过程中的速度调整笔画粗细和形状，增强书写体验。
调用时机：初始化 SDK 之后。

支持版本：2.0.0 及以上。

delegate

nonatomic, weak id<ZegoSuperBoardManagerDelegate> delegate

设置SuperBoardManager的代理者,可以实现对应的代理方法来监听SDK内superBoardSubView的新增、销毁、切换、SDK的异常等。

业务场景：需要在superBoardSubView的新增、销毁、切换等情况下，对界面做出更新。

支持版本：2.0.0 及以上。

superBoardView

nonatomic, strong,readonly ZegoSuperBoardView * superBoardView

开启 SuperBoardView 模式时，获取该对象。

业务场景：在开启 SuperBoardView 模式下，使用该对象上的方法进行 A 端切换白板，B 端自动同步。
默认值：默认获得该对象。
调用时机：初始化 ZegoSuperboard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：如果使用 enableSuperBoardView 接口并设置为 false ，则无法获取 SuperBoardView 对象。

superBoardSubViewModelList

nonatomic, strong,readonly NSArray <ZegoSuperBoardSubViewModel *> * superBoardSubViewModelList

通过superBoardSubViewModelList,可以获取到当前房间内存在的superBoardSubView的数量以及superBoardSubView的信息。

业务场景：进房后需要获取房间内的superBoardSubView列表做展示，在列表中切换当前展示的superBoardSubView。
调用时机：初始化 ZegoSuperboard SDK 之后。

支持版本：2.0.0 及以上。

enableCustomCursor

nonatomic, assign, readwrite BOOL enableCustomCursor

设置是否启用自定义光标，设置为 true 则显示光标。默认为true

业务场景：涂鸦过程中显示光标功能。
调用时机：初始化 SDK 之后。

支持版本：v2.2.0

enableRemoteCursorVisible

nonatomic, assign, readwrite BOOL enableRemoteCursorVisible

设置是否是否显示远端光标，设置为 true 则显示远端的光标。默认为true。

业务场景：涂鸦过程中显示远端光标功能。
调用时机：初始化 SDK 之后。

支持版本：v2.2.0

superBoardMaxScaleFactor

nonatomic, assign, readwrite CGFloat superBoardMaxScaleFactor

调用时机：请在初始化之后，创建文件/白板之前，unInit之后失效。

方法

sharedInstance

static

sharedInstance

+ (ZegoSuperBoardManager *)sharedInstance;

获取 ZegoSuperBoardManager 实例对象。

Declared in ZegoSuperBoardManager.h

获取 ZegoSuperBoardManager 实例对象才能调用 ZegoSuperBoardManager 中的接口方法。

调用时机：集成 ZegoSuperBoard SDK之后，初始化 ZegoSuperBoard SDK 之前。

支持版本：2.0.0 及以上。

ZegoSuperBoardManager 实例对象

setSuperBoardMaxScaleFactor:scaleFactor:

- (void)setSuperBoardMaxScaleFactor:(Float) scaleFactor;

设置超级白板（文件和白板）最大缩放倍数，默认为3倍。可设置的区间为【1,10】

Declared in ZegoSuperBoardManager.h

参数

名称	类型	描述
scaleFactor	Float	详情描述：超级白板（文件和白板）最大缩放倍数

详情

设置超级白板（文件和白板）最大缩放倍数，默认为3倍。可设置的区间为【1,10】

调用时机/通知时机：请在初始化之后，创建文件/白板之前，unInit之后失效。

支持版本：2.3.7

renewToken:token:

- (void)renewToken:(NSString *) token;

更新Token

Declared in ZegoSuperBoardManager.h

参数

名称	类型	描述
token	NSString *	需要更新的 Token。

详情

token 权限变更、或者 token 过期时调用，用于更新 token 权限

默认值：无
调用时机：初始化 SDK 后，借助 ZEGO SDK 的将要过期回调 [tokenWillExpire] 接口，收到 token 将要过期回调，主动更新超级白板的文件服务 token。
影响范围：token 内包含的过期时间，在过期前 30s 会触发 [tokenWillExpire] 回调
相关回调：无
相关接口：[tokenWillExpire]
平台差异：无

setManagerListener:listener:

- (void)setManagerListener:(ZegoSuperBoardManagerDelegate) listener;

设置SDK方法监听

Declared in ZegoSuperBoardManager.h

参数

名称	类型	描述
listener	ZegoSuperBoardManagerDelegate	监听白板回调信息

调用时机：init之后

支持版本：2.0.0及以上

initWithConfig:config:complete:

- (void)initWithConfig:(ZegoSuperBoardInitConfig *) config complete:(ZegoSuperBoardManagerBlock) complete;

初始化 ZegoSuperBoard SDK

Declared in ZegoSuperBoardManager.h

参数

名称	类型	描述
config	ZegoSuperBoardInitConfig *	SDK 初始化所需要的配置信息
complete	ZegoSuperBoardManagerBlock	初始化的结果回调

详情

初始化ZegoSuperBoard SDK的方法。

业务场景：初始化 ZegoSuperBoard SDK。
调用时机：在调用ZegoExpressEngine SDK的loginRoom接口前。
相关接口：unInit。

支持版本：2.0.0 及以上。

setCustomizedConfig:value:key:

- (void)setCustomizedConfig:(nonnull NSString *) value key:(nonnull NSString *) key;

设置配置项 例如： key值为 logPath，SDK记录日志的目录地址。 key值为 cachePath，SDK缓存的目录地址。

Declared in ZegoSuperBoardManager.h

参数

名称	类型	描述
value	nonnull NSString *	value 描述
key	nonnull NSString *	key 描述

调用时机：初始化 Superboard SDK 后调用

支持版本：2.0.0 及以上。

返回值

设置是否成功

enableSuperBoardView:enable:

- (void)enableSuperBoardView:(BOOL) enable;

设置是否使用 SuperBoardView

Declared in ZegoSuperBoardManager.h

参数

名称	类型	描述
enable	BOOL	YES 代表使用SuperBoardView NO代表不使用, 默认为YES

详情

设置是否使用 SuperBoardView。

调用时机：初始化 SDK 之前。

支持版本：2.0.0 及以上。
注意事项：默认开启

createWhiteboardView:config:complete:

- (void)createWhiteboardView:(nonnull ZegoCreateWhiteboardConfig *) config complete:(ZegoSuperBoardManagerCreateBlock) complete;

创建纯白板

Declared in ZegoSuperBoardManager.h

参数

名称	类型	描述
config	nonnull ZegoCreateWhiteboardConfig *	纯白板相关的配置参数
complete	ZegoSuperBoardManagerCreateBlock	创建纯白板的结果回调

详情

创建成功后会内部保存对应的SubView并返回它的 subViewModel 数据

调用时机：初始化 ZegoSuperboard SDK，调用 [loginRoom] 登录房间之后，需要创建纯白板的时候。

支持版本：2.0.0 及以上。

createFileView:config:complete:

- (void)createFileView:(nonnull ZegoCreateFileConfig *) config complete:(ZegoSuperBoardManagerCreateBlock) complete;

创建文件

Declared in ZegoSuperBoardManager.h

参数

名称	类型	描述
config	nonnull ZegoCreateFileConfig *	创建文件需要的配置参数
complete	ZegoSuperBoardManagerCreateBlock	创建文件的结果回调

详情

创建成功后会内部保存对应的SubView并返回它的 subViewModel 数据

调用时机：初始化 ZegoSuperboard SDK，调用 [loginRoom] 登录房间之后，需要创建文件的时候。

支持版本：2.0.0 及以上。

destroySuperBoardSubView:uniqueID:complete:

- (void)destroySuperBoardSubView:(NSString *) uniqueID complete:(ZegoSuperBoardManagerBlock) complete;

销毁指定的 SuperBoardSubView 视图

Declared in ZegoSuperBoardManager.h

参数

名称	类型	描述
uniqueID	NSString *	ZegoSuperBoardSubView 对象的唯一标识
complete	ZegoSuperBoardManagerBlock	销毁指定SuperBoardSubView的结果回调

调用时机：在调用querySuperBoardSubViewList 拉取到列表后或者 superBoardSubViewModelList 获取到model数量大于0的时候调用。

支持版本：2.0.0 及以上。

querySuperBoardSubViewList:complete:

- (void)querySuperBoardSubViewList:(void(^)(ZegoSuperBoardError errorCode,NSArray <ZegoSuperBoardSubViewModel *>*superBoardViewList)) complete;

向服务器查询当前存在的 SuperBoardSubView 列表

Declared in ZegoSuperBoardManager.h

参数

名称	类型	描述
complete	void(^)(ZegoSuperBoardError errorCode,NSArray <ZegoSuperBoardSubViewModel >superBoardViewList)	获取SuperBoardSubView列表的结果回调

详情

调用时机：初始化SDK，登录房间之后调用。

支持版本：2.0.0及以上

getSuperBoardSubView:uniqueID:

- (ZegoSuperBoardSubView *)getSuperBoardSubView:(NSString *) uniqueID;

获取指定的 SuperBoardSubView

Declared in ZegoSuperBoardManager.h

参数

名称	类型	描述
uniqueID	NSString *	ZegoSuperBoardSubView 对象的唯一标识

调用时机：初始化SDK，进房成功后，获取到SuperBoardSubView列表之后调用。

支持版本：2.0.0及以上
注意事项：仅限于不使用 SuperBoardView （通过 enableSuperBoardView 设置）的场景使用

clearCache

- (void)clearCache;

清除文件和白板相关的缓存资源

Declared in ZegoSuperBoardManager.h

调用时机：初始化，进入房间之后，SDK 对于房间内资源的清理，需要在退出房间前主动调用。

支持版本：2.0.0及以上

clear

- (void)clear;

清空房间内资源退房时调用

Declared in ZegoSuperBoardManager.h

退房时需要清空房间内的缓存信息，以及停止媒体播放。

调用时机：需要在退房前主动调用。

支持版本：2.0.0及以上

unInit

- (void)unInit;

反初始化SDK

Declared in ZegoSuperBoardManager.h

调用时机：当你需要重新初始化SDK时，你必须先调用unInit。

支持版本：2.0.0及以上

getSDKVersion

- (NSString *)getSDKVersion;

获取SDK的版本号

Declared in ZegoSuperBoardManager.h

获取 SDK 版本号。

业务场景：1. SDK 在运行过程中，当开发者发现与预期情况不符时，可将问题与相关日志提交给 ZEGO 技术人员定位，ZEGO 技术人员可能需要 SDK 的版本的信息来辅助定位问题。

开发者也可以收集此信息作为 App 所使用的 SDK 的版本信息，以便统计线上各版本 App 对应的各版本 SDK。

调用时机：在任意时刻均可调用。

支持版本：v2.0.0 及以上。

SDK的版本号

getCustomizedConfig:key:

- (NSString *)getCustomizedConfig:(nonnull NSString *) key;

获取设置的配置项的值

Declared in ZegoSuperBoardManager.h

参数

名称	类型	描述
key	nonnull NSString *	要获取的设置项

详情

获取设置的配置项的值。

调用时机：初始化 Superboard SDK，调用 setCustomizedConfig 之后。

支持版本：2.0.0及以上。

ZegoSuperBoardSubView

详情

接口类，用来描述一个纯白板或者文件白板。

业务场景：主要用于对当前展示的白板的操作，设置状态或操作等。

注意事项：需要先登录房间，使用前请先检查是否为空。

Declared in ZegoSuperBoardSubView.h

属性

model

nonatomic,strong,readonly ZegoSuperBoardSubViewModel * model

获取ZegoSuperBoardSubView对应的model数据。

业务场景：获取ZegoSuperBoardSubView对应的model数据，比如ID、名字、关联的文件ID等。

支持版本：2.0.0 及以上。

pageCount

nonatomic,assign,readonly NSInteger pageCount

获取总页码数。

支持版本：2.0.0及以上。

excelSheetNameList

nonatomic,strong,readonly NSArray <NSString *>* excelSheetNameList

获取这个excel文件的所有sheet表的名字。

业务场景：需要展示excel文件的sheet表的时候，通过这个方法获取这个excel文件的所有sheet表的名字。

支持版本：2.0.0 及以上。
注意事项：对于非excel的文件类型返回nil。

currentSheetName

nonatomic,copy,readonly NSString * currentSheetName

获取当前展示的sheet名称,如果不是excel，则返回nil。

支持版本：2.0.0及以上。

visibleSize

nonatomic,assign,readonly CGSize visibleSize

获取SuperBoardSubView 可见内容区域的大小。

支持版本：2.0.0 及以上。

delegate

nonatomic,weak id<ZegoSuperBoardSubViewDelegate> delegate

设置事件通知回调，传 nil 则清空已设置的回调。

支持版本：2.0.0 及以上。

currentPage

nonatomic,assign,readonly NSInteger currentPage

获取当前显示的内容的页码。

支持版本：2.0.0及以上。

方法

setCustomCursorAttribute:type:cursorAttribute:complete:

- (void)setCustomCursorAttribute:(ZegoSuperBoardViewCursorType) type cursorAttribute:(ZegoSuperBoardCursorAttribute *) cursorAttribute complete:(void(^)(int errorCode)) complete;

自定义设置本端自定义光标

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
type	ZegoSuperBoardViewCursorType	设置工具类型，目前仅支持设置画笔样式
cursorAttribute	ZegoSuperBoardCursorAttribute *	光标参数
complete	void(^)(int errorCode)	回调

详情

设置本端自定义光标的指针图标和指针的热点(即自定义图标的实际点击位置)

是否必填：是。
调用时机：开启本端自定义光标之后。

支持版本：2.2.0及以上。
注意事项：设置指针的热点位置，建议两个小于32的无单位非负数。

getThumbnailUrlList

- (NSArray *)getThumbnailUrlList;

获取当前文件的缩略图列表，仅支持 PDF 、PPT、动态 PPT 、H5文件格式

Declared in ZegoSuperBoardSubView.h

如果需要展示文件的预览画面，可以通过这个接口来获取对应的预览图片，然后通过点击预览图片进行翻页。

业务场景：展示文件每一页的预览画面。
调用时机：在文件加载后调用，否则返回一个空列表。

支持版本：2.0.0 及以上。
使用限制：仅支持 PDF 、PPT、动态 PPT 、H5文件格式,其他类型返回一个空的列表。

文件每一页的缩略图的URL地址列表

getPPTNotes:page:

- (NSString *)getPPTNotes:(NSInteger) page;

获取 PPT 指定页码的备注

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
page	NSInteger	指定的页码，从1开始

详情

获取 PPT 指定页码的备注。

业务场景：获取 PPT 指定页码的备注。
调用时机：loadFile 成功之后。

支持版本：2.0.0 及以上。
使用限制：仅支持PPT、动态 PPT 文件格式,其他类型返回null。

返回值

该页备注，若没有备注，则返回空字符串

addTextEditWithComplete:complete:

- (void)addTextEditWithComplete:(nullable ZegoSuperBoardSubViewBlock) complete;

给白板 View 添加文本,调用后会从白板底部弹出输入框。

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
complete	nullable ZegoSuperBoardSubViewBlock	操作结果回调,如果有创建图元的权限，则会成功，否则失败

详情

给白板 View 添加文本,调用后会从白板底部弹出输入框。

业务场景：给白板 View 添加文本,调用后会从白板底部弹出输入框。
默认值：输入框的默认内容是 "文本" ，可以通过 ZegoSuperBoardManager属性customText 设置默认文本，默认显示位置是当前白板范围的中间
相关回调：ZegoSuperBoardSubViewBlock。
相关接口：ZegoSuperBoardManager属性customText。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0 及以上。

addText:text:positionX:positionY:complete:

- (void)addText:(NSString *) text positionX:(int) positionX positionY:(int) positionY complete:(ZegoSuperBoardSubViewBlock) complete;

向白板添加自定义文本

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
text	NSString *	待添加文本图元的字符串内容
positionX	int	相对所在viewport的左上角的横向偏移，如10，此处的viewport是指可写区域
positionY	int	相对所在viewport的左上角的纵向偏移，如10，此处的viewport是指可写区域
complete	ZegoSuperBoardSubViewBlock	操作结果回调,如果有创建图元的权限，则会成功，否则失败

详情

在白板view中添加文本,可以指定添加的位置，不会弹出键盘输入框。

业务场景：在白板view指定位置添加文本，会创建一个新的文本图元。
相关回调：ZegoSuperBoardSubViewBlock。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0 及以上。

undo

- (void)undo;

撤销白板的上一步操作

Declared in ZegoSuperBoardSubView.h

撤销白板的上一步操作。

业务场景：白板的相关操作。
相关接口：redo。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0 及以上。

redo

- (void)redo;

恢复白板上一步撤销的操作

Declared in ZegoSuperBoardSubView.h

恢复白板上一步撤销的操作。

业务场景：白板的相关操作。
相关接口：undo。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0 及以上。

clearCurrentPage:complete:

- (void)clearCurrentPage:(ZegoSuperBoardSubViewBlock) complete;

清除白板当前页的图元

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
complete	ZegoSuperBoardSubViewBlock	操作结果回调。如果删除当前页的图元成功，则会返回成功，否则失败

详情

清除白板当前页的图元。

业务场景：白板相关操作。
相关接口：clearAllPage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上

clearAllPage:complete:

- (void)clearAllPage:(ZegoSuperBoardSubViewBlock) complete;

清除白板所有页的图元

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
complete	ZegoSuperBoardSubViewBlock	操作结果回调。如果有删除图元的权限，则会返回成功，否则失败

详情

清除白板所有页的图元。

业务场景：白板相关操作。
相关接口：clearCurrentPage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。

setOperationMode:mode:

- (void)setOperationMode:(ZegoSuperBoardOperationMode) mode;

设置当前白板的操作模式

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
mode	ZegoSuperBoardOperationMode	操作模式

详情

设置当前白板的操作模式，比如禁止客户端对白板的手势操作。用户可使用按位或的方式同时设置多种模式，比如设置为 ZegoSuperBoardOperationModeZoom | ZegoSuperBoardOperationModeDraw 时，可同时支持放缩模式和绘制模式。

业务场景：设置toolType的时候，需要调用这个方法来对白板进行处理。如果需要禁止客户端对白板的手势操作，可以使用这个方法设置成None模式。如果要滚动文件，则设置成滚动模式，其他的白板工具，则设置成绘制模式
默认值：绘制/缩放模式。
影响范围：设置为滚动模式的时候，此时手势会被识别为滚动，设置为绘制模式的时候，此时手势会被识别为绘制相关的操作。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：只有当 currentSuperBoardSubView 存在时才可调用，可通过 getCurrentSuperBoardSubView() 方法进行判断 currentSuperBoardSubView 是否存在，否则不会有任何效果。

flipToPage:targetPage:complete:

- (void)flipToPage:(NSInteger) targetPage complete:(ZegoSuperBoardSubViewBlock) complete;

跳转到指定页面

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
targetPage	NSInteger	目标页的页码，从1开始
complete	ZegoSuperBoardSubViewBlock	操作结果回调

详情

跳转到指定页面。

业务场景：指定一个页码进行跳转。
相关回调：ZegoSuperBoardSubViewBlock。
相关接口：flipToPrePage，flipToNextPage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：如果是动态ppt或者H5文件，跳转页面可能需要下载图片，动画资源，因此频繁调用可能会导致需要很久才执行完。

flipToPrePage:complete:

- (void)flipToPrePage:(ZegoSuperBoardSubViewBlock) complete;

跳转到上一页

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
complete	ZegoSuperBoardSubViewBlock	操作结果回调

详情

跳转到上一页。

相关回调：ZegoSuperBoardSubViewBlock。
相关接口：flipToPage，flipToNextPage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：如果是动态ppt或者H5文件，跳转页面可能需要下载图片，动画资源，因此频繁调用可能会导致需要很久才执行完。

flipToNextPage:complete:

- (void)flipToNextPage:(ZegoSuperBoardSubViewBlock) complete;

跳转到下一页

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
complete	ZegoSuperBoardSubViewBlock	操作结果回调

详情

跳转到下一页。

相关回调：ZegoSuperBoardSubViewBlock。
相关接口：flipToPage，flipToPrePage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：如果是动态ppt或者H5文件，跳转页面可能需要下载图片，动画资源，因此频繁调用可能会导致需要很久才执行完。

preStep:complete:

- (void)preStep:(ZegoSuperBoardSubViewBlock) complete;

跳转到上一步动画

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
complete	ZegoSuperBoardSubViewBlock	操作结果回调

详情

跳转到上一步动画。

相关回调：ZegoSuperBoardSubViewBlock。
相关接口：nextStep。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：仅仅针对动态ppt或者H5文件，否则不会有任何效果。

nextStep:complete:

- (void)nextStep:(ZegoSuperBoardSubViewBlock) complete;

跳转到下一步动画

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
complete	ZegoSuperBoardSubViewBlock	操作结果回调

详情

跳转到下一步动画。

相关回调：ZegoSuperBoardSubViewBlock。
相关接口：preStep。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：仅仅针对动态ppt或者H5文件，否则不会有任何效果。

switchExcelSheet:sheetIndex:complete:

- (void)switchExcelSheet:(NSInteger) sheetIndex complete:(ZegoSuperBoardSubViewSwitchBlock) complete;

切换excel文件到指定sheet页

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
sheetIndex	NSInteger	excel文件目标sheet表的index
complete	ZegoSuperBoardSubViewSwitchBlock	操作结果回调

详情

切换excel文件到指定sheet页。

默认值：打开excel文件的时候，默认是在第0个sheet页。
相关回调：ZegoSuperBoardSubViewSwitchBlock。
调用时机：当currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。

addImage:type :address:positionX:positionY:complete:

- (void)addImage:(ZegoSuperBoardViewImageType) type  address:(NSString *) address positionX:(int) positionX positionY:(int) positionY complete:(ZegoSuperBoardSubViewBlock) complete;

插入图片到白板

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
type	ZegoSuperBoardViewImageType	图片类型，目前支持普通图片和自定义图形
address	NSString *	图片地址，支持本地图片地址和网络图片地址，本地图片会先上传到cdn存储。目前自定义图形只支持网络图片地址。（网络图片仅支持 https）例："xxxxxxxxxx.png"，"https://xxxxxxxx.com/xxx.png"。
positionX	int	图片插入位置的起始点，相对所在viewport的左上角的横向偏移，如10，此处的viewport是指可写区域。自定义图形直接传 0 即可。
positionY	int	图片插入位置的起始点，相对所在viewport的左上角的纵向偏移，如10，此处的viewport是指可写区域。自定义图形直接传 0 即可。
complete	ZegoSuperBoardSubViewBlock	添加图片结果回调

详情

插入图片到白板显示或者设置自定义图形。

业务场景：设置自定义图形后，在选择白板工具为自定义图形时，触摸白板会绘制此处传入的自定义图形
相关回调：ZegoSuperBoardSubViewBlock。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：支持的图片类型：png/jpg/jpeg，当type为Graphic时，支持本地图片和网络图片，图片大小限制10M，当type为Custom时，只支持网络图片，图片大小限制500KB。

clearSelected:complete:

- (void)clearSelected:(ZegoSuperBoardSubViewBlock) complete;

删除选中的图元

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
complete	ZegoSuperBoardSubViewBlock	操作结果回调

详情

通过白板的选择工具选择一些图元，调用这个方法可以删除选中的图元。

相关回调：ZegoSuperBoardSubViewBlock。
调用时机：获取到SuperBoardSubView列表之后。

支持版本：2.0.0及以上。

setBackgroundImageWithPath:imagePath:mode:complete:

- (void)setBackgroundImageWithPath:(NSString *) imagePath mode:(ZegoSuperBoardViewImageFitMode) mode complete:(ZegoSuperBoardSubViewBlock) complete;

向白板设置背景图

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
imagePath	NSString *	背景图片路径, 本地路径或者网络路径均可（网络图片仅支持 https）例："xxxxxxxxxx.png"，"https://xxxxxxxx.com/xxx.png"。
mode	ZegoSuperBoardViewImageFitMode	背景图片填充模式
complete	ZegoSuperBoardSubViewBlock	背景图片设置完成回调

详情

向白板设置背景图，支持本地路径或者网络路径，这个背景图会同步给房间内的其他用户。

相关回调：ZegoSuperBoardSubViewBlock。
调用时机：获取到SuperBoardSubView列表之后。

支持版本：2.0.0及以上。

clearBackgroundImageWithComplete:complete:

- (void)clearBackgroundImageWithComplete:(ZegoSuperBoardSubViewBlock) complete;

清除白板的背景图

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
complete	ZegoSuperBoardSubViewBlock	清除背景完成回调

详情

清除白板的背景图，这个动作会同步给房间内的其他用户。

相关回调：ZegoSuperBoardSubViewBlock。
调用时机：获取到SuperBoardSubView列表之后。

支持版本：2.0.0及以上。

stopPlayPPTVideo

- (void)stopPlayPPTVideo;

停止当前动态ppt页面正在播放的视频

Declared in ZegoSuperBoardSubView.h

停止当前动态ppt页面正在播放的视频,一般用于切换文件时，停止掉动态 PPT 文件的音视频播放。

调用时机：在文件加载成功之后,播放音视频的过程中调用。

支持版本：2.0.0及以上。

setWhiteboardBackgroundColor:color:

- (void)setWhiteboardBackgroundColor:(UIColor *) color;

设置容器内白板背景色

Declared in ZegoSuperBoardSubView.h

参数

名称	类型	描述
color	UIColor *	白板的颜色

详情

设置白板的背景颜色,比如纯白板设置成灰色等。仅仅在本地生效，不会同步给其他用户。

调用时机：获取到SuperBoardSubView对象时可直接调用。

支持版本：2.0.0及以上。

ZegoSuperBoardSubViewModel

详情

数据模型类，里面包含了创建的ZegoSuperBoardSubView的名称、创建时间、包含的文件ID、文件类型以及ZegoSuperBoardSubView 对象的唯一标识。

业务场景：用户获取对应ZegoSuperBoardSubView对象的ID，名称和文件信息。

Declared in ZegoSuperBoardSubViewModel.h

属性

name

nonatomic, copy NSString * name

SuperBoardSubView 对应的名称

createTime

nonatomic,assign NSUInteger createTime

白板创建时间 Unix 时间戳(毫秒)

fileID

nonatomic,copy NSString * fileID

创建文件白板时使用的文件ID，此 ID 唯一

fileType

nonatomic,assign NSUInteger fileType

创建文件白板时使用的文件类型，详见ZegoSuperBoardFileType

uniqueID

nonatomic,copy NSString * uniqueID

SuperBoardSubview的ID，此ID唯一。

whiteboardIDList

nonatomic,strong NSArray * whiteboardIDList

白板ID的列表

ZegoSuperBoardView

详情

本类主要实现了切换SuperBoardSubView以及 SuperBoardSubView 中Excel文件sheet的功能，初始化SDK后，可以通过ZegoSuperBoardManager获取到ZegoSuperBoardView对象直接使用，通过该类外界不需要再处理ZegoSuperBoardView的切换同步等逻辑，ZegoSuperBoardView会内部处理这些切换同步展示的逻辑。

业务场景：简化接入SDK的复杂度，不想要处理过多的切换ZegoSuperBoardView的逻辑。

注意事项：要使用SuperBoardView需要开启enableSuperBoardView（默认开启）。

Declared in ZegoSuperBoardView.h

属性

currentSuperBoardSubView

nonatomic,strong,readonly ZegoSuperBoardSubView * currentSuperBoardSubView

当前应该展示在视图最顶层的SuperBoardSubView

delegate

nonatomic,weak id<ZegoSuperBoardViewDelegate> delegate

ZegoSuperBoardView的代理

方法

switchSuperBoardSubView:uniqueID:complete:

- (void)switchSuperBoardSubView:(NSString *) uniqueID complete:(ZegoSuperBoardSwitchBlock) complete;

切换到指定的SuperBoardSubView

Declared in ZegoSuperBoardView.h

参数

名称	类型	描述
uniqueID	NSString *	SuperBoardSubView的唯一标识
complete	ZegoSuperBoardSwitchBlock	切换SuperBoardSubView的结果回调

详情

切换到指定SubView，多端同步。

相关回调：ZegoSuperBoardSwitchBlock。

支持版本：2.0.0及以上。

switcSuperBoardSubView:uniqueID:sheetIndex:complete:

- (void)switcSuperBoardSubView:(NSString *) uniqueID sheetIndex:(int) sheetIndex complete:(ZegoSuperBoardSwitchBlock) complete;

切换指定的 SuperBoardSubView 到指定的sheet

Declared in ZegoSuperBoardView.h

参数

名称	类型	描述
uniqueID	NSString *	SuperBoardSubView的唯一标识
sheetIndex	int	excel的sheetIndex
complete	ZegoSuperBoardSwitchBlock	切换Excel的结果回调

详情

切换指定的 SuperBoardSubView中Excel到指定的sheet。

业务场景：切换Excel Sheet。
调用时机：文件加载完成之后调用。

支持版本：2.0.0 及以上。
使用限制：仅支持Excel 类型文件。

返回值

操作结果

ZegoUploadCustomH5Config

详情

自定义H5课件属性构造类，可以设置自定义课件的宽、高、页数以及缩略图信息。

业务场景：在上传自定义H5课件接口中需要传入。

Declared in ZegoUploadCustomH5Config.h

属性

width

nonatomic, assign CGFloat width

是否必填：必填
取值范围：大于0

支持版本：2.0.0及以上

height

nonatomic, assign CGFloat height

是否必填：必填
取值范围：大于0

支持版本：2.0.0及以上

pageCount

nonatomic, assign NSInteger pageCount

是否必填：必填
取值范围：大于0

支持版本：2.0.0及以上

thumbnailList

nonatomic, strong NSArray<NSString *> * thumbnailList

支持版本：2.0.0及以上

Class

ZegoCreateFileConfig

属性

fileID

ZegoCreateWhiteboardConfig

属性

name

perPageWidth

perPageHeight

pageCount

ZegoSuperBoardCursorAttribute

属性

iconPath

offsetX

offsetY

titleStyle

ZegoSuperBoardCursorTitleStyle

属性

title

bold

italic

size

color

backgroundColor

position

ZegoSuperBoardInitConfig

属性

appID

token

userID

appSign

cacheFolder

logFolder

ZegoSuperBoardManager+File

属性

toolType

brushColor

brushSize

fontSize

isFontBold

isFontItalic

customText

enableSyncScale

enableResponseScale

enableHandwriting

delegate

superBoardView

superBoardSubViewModelList

enableCustomCursor

enableRemoteCursorVisible

superBoardMaxScaleFactor

方法

sharedInstance

uploadFile:filePath:renderType:completionBlock:

cancelUploadFileWithSeq:seq:completionBlock:

cacheFileWithFileID:fileID:completionBlock:

cancelCacheFileWithSeq:seq:completionBlock:

queryFileCachedWithFileID:fileID:completionBlock:

uploadH5File:filePath:config:completionBlock:

setSuperBoardMaxScaleFactor:scaleFactor:

renewToken:token:

setManagerListener:listener:

initWithConfig:config:complete:

setCustomizedConfig:value:key:

enableSuperBoardView:enable:

createWhiteboardView:config:complete:

createFileView:config:complete:

destroySuperBoardSubView:uniqueID:complete:

querySuperBoardSubViewList:complete:

getSuperBoardSubView:uniqueID:

clearCache

clear

unInit

getSDKVersion

getCustomizedConfig:key:

ZegoSuperBoardManager+WhiteBoard

属性

toolType

brushColor

brushSize