ZoomSDKCustomizedAnnotationCtr Class Reference

Inheritance diagram for ZoomSDKCustomizedAnnotationCtr:

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

Protected Attributes
id< ZoomSDKCustomizedAnnotationCtrlDelegate >	_delegate

Properties
id< ZoomSDKCustomizedAnnotationCtrlDelegate >	delegate

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

annotation	Specify the annotation that you want to operate on.
canDisable	A 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

annotation	Specify the annotation that you want to operate on.
canAnnotate	A 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

annotation

Specify 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

annotation	Specify the annotation that you want to create.
element	The 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

annotation	Specify the annotation that you want to operate on.
disable	YES 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

annotation	Specify the annotation that you want to operate on.
locked	A 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.

---

The documentation for this class was generated from the following file:

• ZoomSDKCustomizedAnnotationCtr.h