互动白板

API参考

- (void)setPageBackgroundColor:(UIColor *)pageBackgroundColor

  • 功能 : 设置内容页背景色,默认白色
  • 返回值 : 无
参数 类型 含义
pageBackgroundColor UIColor 内容页背景色

- (void)registerWhiteBoardCallback

  • 功能 : 注册内部事件的监听者,以便处理图元等各种消息
  • 返回值 : 无

- (void)removeWhiteBoardCallBack

  • 功能 : 清理内部事件监听者,需要移除释放
  • 返回值 : 无

- (void)setBoardViewCallback:(id<CLBoardViewCallBack>)callback

  • 功能 : 设置View的代理对象
  • 返回值 : 无
参数 类型 含义
callback CLBoardViewCallBack View代理对象

- (void)createWhiteBoard:(int)w h:(int)h pageCount:(int)pageCount pageMode:(CLPageMode)pageMode exInfo:(NSString *)exInfo

  • 功能 : 创建白板
  • 返回值 : 无
参数 类型 含义
width int 宽度
height int 高度
pageCount int 页数
pageMode CLPageMode 翻页模式, 详情请参考CLPageMode
exInfo NSString 白板的扩展信息<=4KB(Json格式)

- (void)notifyCreateBoard:(BoardInfo *)board operatorID:(NSString *)operatorID

  • 功能 : 通知白板创建
  • 返回值 : 无
参数 类型 含义
board BoardInfo 白板信息,详情请参考BoardInfo
operatorID NSString 操作者ID

- (void)closeBoard:(NSString *)boardID

  • 功能 : 关闭白板
  • 返回值 : 无
参数 类型 含义
boardID NSString 白板ID

- (void)notifyCloseBoard:(BoardInfo *)boardID operatorID:(NSString *)operatorID

  • 功能 : 关闭白板通知
  • 返回值 : 无
参数 类型 含义
boardID NSString 白板ID
operatorID NSString 操作者ID

- (NSArray *)getAllBoard

  • 功能 : 获取所有白板
  • 返回值 : 所有白板ID

- (void)updateBoardExInfo:(NSString *)boardID exInfo:(NSString *)exInfo

  • 功能 : 更新白板的扩展信息
  • 返回值 : 无
参数 类型 含义
boardID NSString 白板ID
exInfo NSString 扩展信息

- (void)notifyBoardExInfoUpdated:(NSString *)boardID exInfo:(NSString *)exInfo operatorID:(NSString *)operatorID

  • 功能 : 通知白板扩展信息有更新
  • 返回值 : 无
参数 类型 含义
boardID NSString 白板ID
exInfo NSString 扩展信息
operatorID NSString 操作者ID

- (void)notifyInitBoardList:(NSArray<NSString *> *)boardIDList

  • 功能 : 通知白板列表
  • 返回值 : 无
参数 类型 含义
boardIDList NSArray 白板ID列表

- (BoardInfo *)getBoardInfo:(NSString *)boardID

  • 功能 : 获取白板信息
  • 返回值 : 白板信息
参数 类型 含义
boardID NSString 白板ID

- (NSString *)getCurrentBoard

  • 功能 : 获取白板信息
  • 返回值 : 白板ID

- (void)setCurrentBoard:(NSString *)boardID

  • 功能 : 设置当前白板
  • 返回值 : 无
参数 类型 含义
boardID NSString 白板ID

- (void)notifyCurrentBoard:(NSString *)boardID operatorID:(NSString *)operatorID

  • 功能 : 通知更换当前白板
  • 返回值 : 无
参数 类型 含义
boardID NSString 白板ID
operatorID NSString 操作者ID

- (void)notifyViewScaleChanged:(NSString *)boardID boardView:(CLBoardView *)boardView scale:(int)scale

  • 功能 : 通知白板缩放比改变
  • 返回值 : 无
参数 类型 含义
wID NSString 白板ID
scale int 缩放系数(50%-500%)
opId String 操作者ID

- (void)setBoardID:(NSString *__nullable)boardID callBack:(id<CLBoardViewCallBack>__nullable)callBack jsonAttr:(NSMutableDictionary *__nullable)jsonAttr

  • 功能 : 配置白板View
  • 返回值 : 无
参数 类型 含义
boardID NSString 白板ID
callBack int 白板View事件回调对象
jsonAttr int 白板View属性

- (void)configBoardTextViewContainer:(UIView *)textViewContainer

  • 功能 : 配置白板文本图元输入控件的父视图,建议使用当前控制器的View方便内部控制textView效果
  • 返回值 : 无
参数 类型 含义
textViewContainer UIView 输入控件的父视图

- (void)resignTextViewFirstResponder

  • 功能 : 取消内部输入控件的第一响应
  • 返回值 : 无

- (void)setBoardViewAttr:(CLBoardViewAttr *)jsonAttr

  • 功能 : 更新白板View属性
  • 返回值 : 无
参数 类型 含义
jsonAttr CLBoardViewAttr 白板View属性,详情请参考CLBoardViewAttr

- (CLBoardViewAttr *)getBoardViewAttr

  • 功能 : 获取白板View属性
  • 返回值 : 白板View属性

- (void)setBoardViewToolType:(CLShapeType)type

  • 功能 : 设置view的工具类型
  • 返回值 : 无
参数 类型 含义
type CLShapeType 工具类型, 详情请参考CLShapeType

- (CLShapeType)getBoardViewToolType

  • 功能 : 获取view的工具类型
  • 返回值 : 工具类型

- (void)setBoardViewCurPage:(NSInteger)pageNum

  • 功能 : 设置View的当前页
  • 返回值 : 无
参数 类型 含义
pageNum NSInteger 当前页

- (NSInteger)getBoardViewCurPage

  • 功能 : 获取View的当前页
  • 返回值 : 当前页

- (void)clearCurPage

  • 功能 : 清空当页标注
  • 返回值 : 无

- (void)clearAllPage

  • 功能 : 清空整个View的标注
  • 返回值 : 无

- (BOOL)getRedoEnableState

  • 功能 : 获取是否可以redo
  • 返回值 : 可用状态

- (BOOL)getUndoEnableState

  • 功能 : 获取是否可以undo
  • 返回值 : 可用状态

- (void)undo

  • 功能 : 撤销
  • 返回值 : 无

- (void)redo

  • 功能 : 恢复
  • 返回值 : 无

- (void)setBoardViewToolAttr:(CLBoardViewToolAttr *)property

  • 功能 : 设置View的工具属性
  • 返回值 : 无
参数 类型 含义
property CLBoardViewToolAttr view属性, 详情请参考CLBoardViewToolAttr

- (CLBoardViewToolAttr *)getBoardViewToolAttr

  • 功能 : 获取View的工具属性
  • 返回值 : 白板View的工具属性

- (void)setViewScale:(CGFloat)scale

  • 功能 : 设置View的缩放系数
  • 返回值 : 无
参数 类型 含义
scale CGFloat 缩放系数 0.5~5.0

- (CGFloat)getViewScale

  • 功能 : 获取View的缩放系数
  • 返回值 : 白板View属性

- (void)notifyBoardCurPageChanged:(CLBoardView *)boardView curPage:(NSInteger)curPage operatorID:(NSString *)operatorID

  • 功能 : 通知白板View翻页变化
  • 返回值 : 无
参数 类型 含义
boardView CLBoardView 白板view
curPage NSInteger 当前页
operatorID NSString 操作者

- (void)notifyRedoEnableChanged:(CLBoardView *)boardView bEnable:(BOOL)bEnable

  • 功能 : 通知白板View可重做状态
  • 返回值 : 无
参数 类型 含义
boardView CLBoardView 白板view
bEnable BOOL 可用状态

- (void)notifyUndoEnableChanged:(CLBoardView *)boardView bEnable:(BOOL)bEnable;

  • 功能 : 通知白板View可撤销状态
  • 返回值 : 无
参数 类型 含义
boardView CLBoardView 白板view
bEnable BOOL 可用状态

- (void)notifyViewScaleChanged:(NSString *)boardID boardView:(CLBoardView *)boardView scale:(int)scale

  • 功能 : 通知白板view放大系数改变
  • 返回值 : 无
参数 类型 含义
boardView CLBoardView 白板view
scale int 放大系数

- (void)notifyMarkException:(CLBoardView *)boardView exType:(CLBoardViewMarkExceptionType)exType

  • 功能 : 通知白板view标注异常
  • 返回值 : 无
参数 类型 含义
boardView CLBoardView 白板view
exType CLBoardViewMarkExceptionType 异常原因,详情参考CLBoardViewMarkExceptionType