macOS SDK API Reference
Loading...
Searching...
No Matches
ZoomSDKCustomizedAnnotationCtr Class Reference

#import <ZoomSDKCustomizedAnnotationCtr.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError- createCustomizedAnnotation:ShareElement:
 Create custom annotation.
 
(ZoomSDKError- cleanCustomizedAnnatation:
 Destroy custom annotations.
 
(ZoomSDKError- disableViewerAnnotation:disable:
 This method is used for the sharing user to disable/enable viewer's privilege of annotation.
 
(ZoomSDKError- isViewerAnnotationLocked:isLocked:
 Determine whether the viewer's annotate privilege is locked.
 
(ZoomSDKError- canDisableViewerAnnotation:canDisabled:
 Determine if it is able for user to disable viewer's annotation privilege.
 
(ZoomSDKError- canDoAnnotation:canAnnotate:
 Determine if it is able for user to do annotation.
 

Protected Attributes

id< ZoomSDKCustomizedAnnotationCtrlDelegate_delegate
 

Properties

id< ZoomSDKCustomizedAnnotationCtrlDelegatedelegate
 

Detailed Description

Definition at line 122 of file ZoomSDKCustomizedAnnotationCtr.h.

Method Documentation

◆ canDisableViewerAnnotation:canDisabled:

- (ZoomSDKError) canDisableViewerAnnotation: (ZoomSDKCustomizedAnnotation *)  annotation
canDisabled: (BOOL *)  canDisable 

Determine if it is able for user to disable viewer's annotation privilege.

Parameters
annotationSpecify the annotation that you want to operate on.
canDisableA point to A BOOL, if function call successfully, the value of 'canDisable' means whether the user can disable viewer's annotation, YES means can disable, NO means cannot.
Returns
A ZoomSDKError to tell client function call successful or not.

◆ canDoAnnotation:canAnnotate:

- (ZoomSDKError) canDoAnnotation: (ZoomSDKCustomizedAnnotation *)  annotation
canAnnotate: (BOOL *)  canAnnotate 

Determine if it is able for user to do annotation.

Parameters
annotationSpecify the annotation that you want to operate on.
canAnnotateA point to A BOOL, if function call successfully, the value of 'canAnnotate' means whether the user can do annotation, YES means can do annotation, NO means cannot.
Returns
A ZoomSDKError to tell client function call successful or not.

◆ cleanCustomizedAnnatation:

- (ZoomSDKError) cleanCustomizedAnnatation: (ZoomSDKCustomizedAnnotation *)  annotation

Destroy custom annotations.

Parameters
annotationSpecify the annotation that you want to destroy.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ createCustomizedAnnotation:ShareElement:

- (ZoomSDKError) createCustomizedAnnotation: (ZoomSDKCustomizedAnnotation **)  annotation
ShareElement: (ZoomSDKShareElement *)  element 

Create custom annotation.

Parameters
annotationSpecify the annotation that you want to create.
elementThe pointer to ZoomSDKShareElement.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ disableViewerAnnotation:disable:

- (ZoomSDKError) disableViewerAnnotation: (ZoomSDKCustomizedAnnotation *)  annotation
disable: (BOOL)  disable 

This method is used for the sharing user to disable/enable viewer's privilege of annotation.

Parameters
annotationSpecify the annotation that you want to operate on.
disableYES means disable viewer's annotation privilege, NO means enable.
Returns
A ZoomSDKError to tell client function call successful or not.

◆ isViewerAnnotationLocked:isLocked:

- (ZoomSDKError) isViewerAnnotationLocked: (ZoomSDKCustomizedAnnotation *)  annotation
isLocked: (BOOL *)  locked 

Determine whether the viewer's annotate privilege is locked.

Parameters
annotationSpecify the annotation that you want to operate on.
lockedA point to A BOOL, if function call successfully, the value of 'locked' means whether viewer's annotate privilege is locked, YES means viewer's annotate privilege is locked.
Returns
A ZoomSDKError to tell client function call successful or not.

Field Documentation

◆ _delegate

- (id<ZoomSDKCustomizedAnnotationCtrlDelegate>) _delegate
protected

Definition at line 124 of file ZoomSDKCustomizedAnnotationCtr.h.

Property Documentation

◆ delegate

- (id<ZoomSDKCustomizedAnnotationCtrlDelegate>) delegate
readwritenonatomicassign

Definition at line 126 of file ZoomSDKCustomizedAnnotationCtr.h.