logo
On this page

Protocol

2026-01-23
ZegoSuperBoardManagerDelegateZegoSuperBoardSubViewDelegate
ZegoSuperBoardViewDelegate

ZegoSuperBoardManagerDelegate

ZegoSuperBoardManager for some synchronization information and error message callbacks

Declared in ZegoSuperBoardManager.h

Methods

onError:error:

onError:error:
- (void)onError:(ZegoSuperBoardError) error;
The callback notification is generated when an internal error occurs on the SuperBoard. You can know the specific error type based on the corresponding error code. For the error code, see ZegoSuperBoardError
Declared in ZegoSuperBoardManager.h

Parameters

NameTypeDescription
errorZegoSuperBoardError
  • Trigger: Error callbacks in procedures using the ZegoSuperBoard SDK.
  • Available since: v2.0.0.

When to

onRemoteSuperBoardSubViewAdded:model:

onRemoteSuperBoardSubViewAdded:model:
- (void)onRemoteSuperBoardSubViewAdded:(ZegoSuperBoardSubViewModel *) model;
Received the new callback from SuperBoardSubView. Procedure
Declared in ZegoSuperBoardManager.h

Parameters

NameTypeDescription
modelZegoSuperBoardSubViewModel *Corresponds to the model of the added SuperBoardSubView
  • Trigger: After another user in the same room successfully creates a whiteboard or file (by invoking [createWhiteboardView] or [createFileView]), the local end receives this notification.
  • Available since: v2.0.0 .

When to

onRemoteSuperBoardSubViewRemoved:model:

onRemoteSuperBoardSubViewRemoved:model:
- (void)onRemoteSuperBoardSubViewRemoved:(ZegoSuperBoardSubViewModel *) model;
Callback to receive the SuperBoardSubView destruction message
Declared in ZegoSuperBoardManager.h

Parameters

NameTypeDescription
modelZegoSuperBoardSubViewModel *Model of the corresponding SuperBoardSubView
  • Trigger: After another member in the same room successfully destroys ZegoSuperBoardSubView (calling [destroySuperBoardSubView]), the local end will receive this notification.
  • Available since: v2.0.0

When to

onRemoteSuperBoardSubViewSwitched:uniqueID:

onRemoteSuperBoardSubViewSwitched:uniqueID:
- (void)onRemoteSuperBoardSubViewSwitched:(NSString *) uniqueID;
Received message callback for SuperBoardSubView toggle
Declared in ZegoSuperBoardManager.h

Parameters

NameTypeDescription
uniqueIDNSString *The uniqueID of the corresponding SuperBoardSubView to which to switch
  • Trigger: After ZegoSuperBoardSubView is successfully switched by other members in the same room (by calling switchSubView), the local end receives this notification.
  • Available since: v2.0.0

When to

onRemoteSuperBoardAuthChanged:authInfo:

onRemoteSuperBoardAuthChanged:authInfo:
- (void)onRemoteSuperBoardAuthChanged:(NSDictionary *) authInfo;
Callback method after receiving SuperBoardSubView operation permission change
Declared in ZegoSuperBoardManager.h

Parameters

NameTypeDescription
authInfoNSDictionary *authInfo The value of scale and Scroll keys is 0 and 1 (0 indicates that the corresponding permission is off and 1 indicates that the corresponding permission is on).

Details

The whiteboard operation permission change callback is used to control the operation of the whiteboard, including zooming and scrolling.

When to

  • Trigger: Received the permission change notification in the background.
  • Available since: v2.0.0

onRemoteSuperBoardGraphicAuthChanged:authInfo:

onRemoteSuperBoardGraphicAuthChanged:authInfo:
- (void)onRemoteSuperBoardGraphicAuthChanged:(NSDictionary *) authInfo;
Callback for changes in primitives operation rights<br/>Graphic operation rights including create, delete, move, update, empty all graphic
Declared in ZegoSuperBoardManager.h

Parameters

NameTypeDescription
authInfoNSDictionary *AuthInfo Contains five keys: create, DELETE, move, Update, and clear. The values are 0 and 1 (0 indicates that the corresponding permission is off and 1 indicates that the corresponding permission is on).

Details

The primitive operation permissions include creating, deleting, moving, updating, and clearing all primitives.

  • When to call /Trigger: Received the permission change notification in the background.
  • Available since: v2.0.0

ZegoSuperBoardSubViewDelegate

ZegoSuperBoardSubView internal change callback

Declared in ZegoSuperBoardSubView.h

Methods

onScrollChange:currentPage:pageCount:subViewModel:

onScrollChange:currentPage:pageCount:subViewModel:
- (void)onScrollChange:(NSInteger) currentPage pageCount:(NSInteger) pageCount subViewModel:(ZegoSuperBoardSubViewModel *) subViewModel;
Callback that receives a page change
Declared in ZegoSuperBoardSubView.h

Parameters

NameTypeDescription
currentPageNSIntegerCurrent page number after page change
pageCountNSIntegerThe total page number
subViewModelZegoSuperBoardSubViewModel *ZegoSuperBoardSubView object corresponding to the subViewModel

Details

When the onScrollChange callback is received, the SDK has handled the update of the whiteboard and file page number internally, and the interface can get the current page number user display through the callback.

When to

  • Trigger: This callback is triggered when scrolling or page turning occurs within the file or whiteboard.
  • Available since: v2.0.0.

onSizeChange:size:subViewModel:

onSizeChange:size:subViewModel:
- (void)onSizeChange:(CGSize) size subViewModel:(ZegoSuperBoardSubViewModel *) subViewModel;
Page size change callback
Declared in ZegoSuperBoardSubView.h

Parameters

NameTypeDescription
sizeCGSizeThe size of the visible content inside the SuperBoardSubView
subViewModelZegoSuperBoardSubViewModel *ZegoSuperBoardSubView object corresponding to the subViewModel

Details

When the onSizeChange callback is received, the SDK has already handled the whiteboard and file Size updates internally. The interface can get the Size of the current viewable content area in the SuperBoardSubView view through the callback.

When to

  • Trigger: This callback is triggered when the ZegoSuperBoardSubView size is changed.
  • Available since: v2.0.0

onScaleChangedWithScaleFactor:scaleFactor:scaleOffsetX:scaleOffsetY:subViewModel:

onScaleChangedWithScaleFactor:scaleFactor:scaleOffsetX:scaleOffsetY:subViewModel:
- (void)onScaleChangedWithScaleFactor:(CGFloat) scaleFactor scaleOffsetX:(CGFloat) scaleOffsetX scaleOffsetY:(CGFloat) scaleOffsetY subViewModel:(ZegoSuperBoardSubViewModel *) subViewModel;
Minimize notifications.
Declared in ZegoSuperBoardSubView.h

Parameters

NameTypeDescription
scaleFactorCGFloatZooming coefficient
scaleOffsetXCGFloatHorizontal offset generated during zooming
scaleOffsetYCGFloatVertical offset generated during zooming
subViewModelZegoSuperBoardSubViewModel *subViewModel of the ZegoSuperBoardSubView object

Details

Implement this method to respond to zooming.

When to

  • Trigger: After the zooming operation, this callback method is called to notify the service layer. SDK users obtain the zooming coefficient based on the method parameters.

onStepChange

onStepChange
- (void)onStepChange;
Notification of animation step changes in dynamic PPT.
Declared in ZegoSuperBoardSubView.h

Implement this method to monitor the animation step changes in the dynamic PPT.

When to Trigger Notify when the animation steps in the dynamic PPT change.

ZegoSuperBoardViewDelegate

ZegoSuperBoardView event callback

Declared in ZegoSuperBoardView.h

Methods

onScrollChange:currentPage:pageCount:subViewModel:

onScrollChange:currentPage:pageCount:subViewModel:
- (void)onScrollChange:(NSInteger) currentPage pageCount:(NSInteger) pageCount subViewModel:(ZegoSuperBoardSubViewModel *) subViewModel;
Page change callback
Declared in ZegoSuperBoardView.h

Parameters

NameTypeDescription
currentPageNSIntegerCurrent page number after page change
pageCountNSIntegerTotal number of pages
subViewModelZegoSuperBoardSubViewModel *ZegoSuperBoardSubView object corresponding to the subViewModel

Details

When the onScrollChange callback is received, the SDK has handled the update of the whiteboard and file page number internally, and the interface can get the current page number user display through the callback.

When to

  • Trigger: This callback is triggered when scrolling or page turning occurs within the file or whiteboard.
  • Available since: v2.0.0.

onSizeChange:size:subViewModel:

onSizeChange:size:subViewModel:
- (void)onSizeChange:(CGSize) size subViewModel:(ZegoSuperBoardSubViewModel *) subViewModel;
Page size change callback
Declared in ZegoSuperBoardView.h

Parameters

NameTypeDescription
sizeCGSizeSuperBoardSubView Size of visible content
subViewModelZegoSuperBoardSubViewModel *ZegoSuperBoardSubView object corresponding to the subViewModel

Details

When the onSizeChange callback is received, the SDK has already handled the whiteboard and file Size updates internally. The interface can get the Size of the current viewable content area in the SuperBoardSubView view through the callback.

When to

  • Trigger: This callback is triggered when the ZegoSuperBoardSubView size is changed.
  • Available since: v2.0.0

onStepChange

onStepChange
- (void)onStepChange;
Notification of animation step changes in dynamic PPT.
Declared in ZegoSuperBoardView.h

Implement this method to monitor the animation step changes in the dynamic PPT.

When to Trigger Notify when the animation steps in the dynamic PPT change.

Previous

Class

Next

Enum

On this page

Back to top