ZoomSDKCustomizedAnnotationCtr Class Reference

Controller class to create and manage customized annotations. More...

#include <ZoomSDKCustomizedAnnotationCtr.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- createCustomizedAnnotation:ShareElement:
	Creates custom annotation.
(ZoomSDKError)	- cleanCustomizedAnnotation:
	Destroy custom annotations.
(ZoomSDKError)	- disableViewerAnnotation:disable:
	This method uses for the sharing user to disable or enable viewer's privilege of annotation.
(ZoomSDKError)	- isViewerAnnotationLocked:isLocked:
	Determines whether the viewer's annotate privilege is locked.
(ZoomSDKError)	- canDisableViewerAnnotation:canDisabled:
	Determines if it is able for user to disable viewer's annotation privilege.
(ZoomSDKError)	- canDoAnnotation:canAnnotate:
	Determines if it is able for user to do annotation.

Protected Attributes
id< ZoomSDKCustomizedAnnotationCtrlDelegate >	_delegate

Properties
id< ZoomSDKCustomizedAnnotationCtrlDelegate >	delegate
	Delegate to receive annotation control events.

Detailed Description

Controller class to create and manage customized annotations.

Definition at line 161 of file ZoomSDKCustomizedAnnotationCtr.h.

Method Documentation

canDisableViewerAnnotation:canDisabled:

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

Determines 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 if can disable, NO if cannot.

Returns

A ZoomSDKError to tell client function call successful or not. Otherwise, this function returns an error.

canDoAnnotation:canAnnotate:

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

Determines 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 if can do annotation, NO if cannot.

Returns

A ZoomSDKError to tell client function call successful or not. Otherwise, this function returns an error.

cleanCustomizedAnnotation:

- (ZoomSDKError) cleanCustomizedAnnotation:

(ZoomSDKCustomizedAnnotation *)

annotation

Destroy custom annotations.

Parameters

annotation

Specify the annotation that you want to destroy.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

createCustomizedAnnotation:ShareElement:

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

Creates custom annotation.

Parameters

annotation	Specify the annotation that you want to create.
element	The pointer to ZoomSDKShareElement .

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

disableViewerAnnotation:disable:

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

This method uses for the sharing user to disable or enable viewer's privilege of annotation.

Parameters

annotation	Specify the annotation that you want to operate on.
disable	YES to disable viewer's annotation privilege, NO to enable.

Returns

A ZoomSDKError to tell client function call successful or not. Otherwise, this function returns an error.

isViewerAnnotationLocked:isLocked:

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

Determines 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 if viewer's annotate privilege is locked, NO otherwise.

Returns

A ZoomSDKError to tell client function call successful or not. Otherwise, this function returns an error.

Field Documentation

_delegate

- (id<ZoomSDKCustomizedAnnotationCtrlDelegate>) _delegate

protected

Definition at line 163 of file ZoomSDKCustomizedAnnotationCtr.h.

Property Documentation

delegate

- (id<ZoomSDKCustomizedAnnotationCtrlDelegate>) delegate

readwritenonatomicassign

Delegate to receive annotation control events.

Definition at line 168 of file ZoomSDKCustomizedAnnotationCtr.h.