ZoomSDKMeetingDocsController Class Reference

Zoom SDK meeting docs sharing controller. More...

#include <ZoomSDKMeetingDocsController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSupportDocs
	Determines whether the current meeting supports docs or not.
(BOOL)	- canStartShareDocs:
	Determines whether the current user can start sharing the docs or not.
(BOOL)	- canSetDocsOption
	Determines whether the current user can set docs options or not.
(BOOL)	- isOtherSharingDocs
	Query if other user is sharing docs.
(BOOL)	- isSharingDocsOut
	Query if the current user is sharing docs successfully.
(ZoomSDKError)	- setDocsShareOption:
	Sets the docs'setting option for who can share docs.
(ZoomSDKDocsShareOption)	- getDocsShareOption
	Gets the setting option indicating who can share documents.
(ZoomSDKError)	- setDocsCreateOption:
	Sets the setting option for who can initiate new docs.
(ZoomSDKDocsCreateOption)	- getDocsCreateOption
	Gets the setting option indicating whether the user can initiate new docs.
(ZoomSDKError)	- showDashboardWindow:
	Shows the dashboardView web view window.
(ZoomSDKError)	- setDocsWindowPos:
	Sets the docs web view window position.
(ZoomSDKError)	- setDocsWindowSize:
	Sets the docs web view window size.
(ZoomSDKError)	- showDocsWindow:
	Shows the docs web view window.
(ZoomSDKError)	- closeDocsWindow
	Closes the docs web view window.
(NSArray< NSNumber * > *_Nullable)	- getViewableSharingUserList
	Gets the ID of users who are sharing docs.
(NSArray< ZoomSDKDocsSharingSourceInfo * > *_Nullable)	- getSharingSourceInfoList:
	Gets the list of docs sharing source info.

Properties
id< ZoomSDKMeetingDocsControllerDelegate >	delegate
	The delegate object to receive docs sharing events.

Detailed Description

Zoom SDK meeting docs sharing controller.

Definition at line 65 of file ZoomSDKMeetingDocsController.h.

Method Documentation

canSetDocsOption

- (BOOL) canSetDocsOption

Determines whether the current user can set docs options or not.

Returns

YES if the current user can set docs options. Otherwise, NO.

canStartShareDocs:

- (BOOL) canStartShareDocs:

(ZoomSDKCannotShareReasonType *)

reason

Determines whether the current user can start sharing the docs or not.

Parameters

reason

The reason why no one can start sharing the docs.

Returns

YES if you can start sharing the docs. Otherwise, NO.

closeDocsWindow

- (ZoomSDKError) closeDocsWindow

Closes the docs web view window.

Returns

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

Note

Only available for the custom UI.

getDocsCreateOption

- (ZoomSDKDocsCreateOption) getDocsCreateOption

Gets the setting option indicating whether the user can initiate new docs.

Returns

The docs creation option.

getDocsShareOption

- (ZoomSDKDocsShareOption) getDocsShareOption

Gets the setting option indicating who can share documents.

Returns

The docs share option.

getSharingSourceInfoList:

- (NSArray< ZoomSDKDocsSharingSourceInfo * > *_Nullable) getSharingSourceInfoList:

(unsigned int)

userID

Gets the list of docs sharing source info.

Parameters

userID

The user's ID who is sharing docs.

Returns

If the function succeeds, it returns a pointer to the NSArray<ZoomSDKDocsSharingSourceInfo*>. Otherwise, this function fails and returns nil.

getViewableSharingUserList

- (NSArray< NSNumber * > *_Nullable) getViewableSharingUserList

Gets the ID of users who are sharing docs.

Returns

A list of userID of all users who are sharing docs. Otherwise, this function fails and returns nil.

isOtherSharingDocs

- (BOOL) isOtherSharingDocs

Query if other user is sharing docs.

Returns

YES if sharing. Otherwise, NO.

isSharingDocsOut

- (BOOL) isSharingDocsOut

Query if the current user is sharing docs successfully.

Returns

YES if sharing successfully. Otherwise, NO.

isSupportDocs

- (BOOL) isSupportDocs

Determines whether the current meeting supports docs or not.

Returns

YES if that the current meeting supports docs. Otherwise, NO.

setDocsCreateOption:

- (ZoomSDKError) setDocsCreateOption:

(ZoomSDKDocsCreateOption)

option

Sets the setting option for who can initiate new docs.

Parameters

option

Docs setting option for who can initiate new docs.

Returns

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

setDocsShareOption:

- (ZoomSDKError) setDocsShareOption:

(ZoomSDKDocsShareOption)

option

Sets the docs'setting option for who can share docs.

Parameters

option

The setting for who can share docs.

Returns

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

setDocsWindowPos:

- (ZoomSDKError) setDocsWindowPos:

(NSPoint)

point

Sets the docs web view window position.

Parameters

point

The original point to display docs web view window. Default is (0,0).

Returns

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

Note

Only available for the custom UI.

setDocsWindowSize:

- (ZoomSDKError) setDocsWindowSize:

(NSSize)

size

Sets the docs web view window size.

Parameters

size	The size of display docs web view window. If the size is (0,0), the window size will be default size.

Returns

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

Note

Only available for the custom UI.

showDashboardWindow:

- (ZoomSDKError) showDashboardWindow:

(NSPoint)

point

Shows the dashboardView web view window.

Parameters

point

The original point to display dashboard web view window. Default is (0,0).

Returns

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

Note

Only available for the custom UI.

showDocsWindow:

- (ZoomSDKError) showDocsWindow:

(unsigned int)

shareSourceID

Shows the docs web view window.

Parameters

shareSourceID

The share source ID that is sharing.

Returns

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

Note

Only available for the custom UI.

Property Documentation

delegate

- (id<ZoomSDKMeetingDocsControllerDelegate>) delegate

readwritenonatomicassign

The delegate object to receive docs sharing events.

Definition at line 69 of file ZoomSDKMeetingDocsController.h.