ZoomSDKMeetingDocsController Class Reference

#include <ZoomSDKMeetingDocsController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSupportDocs
	Determine whether the current meeting supports docs or not.
(BOOL)	- canStartShareDocs:
	Determine whether the current user can start sharing the docs or not.
(BOOL)	- canSetDocsOption
	Determine 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:
	Set the docs'setting option for who can share docs.
(ZoomSDKDocsShareOption)	- getDocsShareOption
	Get the setting option for who can share docs.
(ZoomSDKError)	- setDocsCreateOption:
	Set the setting option for who can initiate new docs.
(ZoomSDKDocsCreateOption)	- getDocsCreateOption
	Get the docs'setting option for can initiate new docs.
(ZoomSDKError)	- showDashboardWindow:
	Show the dashboardView web view window.
(ZoomSDKError)	- setDocsWindowPos:
	Set the docs web view window position.
(ZoomSDKError)	- setDocsWindowSize:
	Set the docs web view window size.
(ZoomSDKError)	- showDocsWindow:
	Show the docs web view window.
(ZoomSDKError)	- closeDocsWindow
	Close the docs web view window.
(NSArray< NSNumber * > *_Nullable)	- getViewableSharingUserList
	Get the ID of users who are sharing docs.
(NSArray< ZoomSDKDocsSharingSourceInfo * > *_Nullable)	- getSharingSourceInfoList:
	Get the list of docs sharing source info.

Properties
id< ZoomSDKMeetingDocsControllerDelegate >	delegate

Detailed Description

Definition at line 43 of file ZoomSDKMeetingDocsController.h.

Method Documentation

canSetDocsOption

- (BOOL) canSetDocsOption

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

Returns

YES means the current user can set docs options, NO means the user can' not set docs options.

canStartShareDocs:

- (BOOL) canStartShareDocs:

(ZoomSDKCannotShareReasonType *)

reason

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

Parameters

reason

The reason why no one can start sharing the docs. See ZoomSDKCannotShareReasonType.

Returns

YES indicates you can start sharing the docs.

closeDocsWindow

- (ZoomSDKError) closeDocsWindow

Close the docs web view window.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, the function fails.

Note

Only available for the custom UI.

getDocsCreateOption

- (ZoomSDKDocsCreateOption) getDocsCreateOption

Get the docs'setting option for can initiate new docs.

Returns

Option, see ZoomSDKDocsCreateOption.

getDocsShareOption

- (ZoomSDKDocsShareOption) getDocsShareOption

Get the setting option for who can share docs.

Returns

Option, see ZoomSDKDocsShareOption.

getSharingSourceInfoList:

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

(unsigned int)

userID

Get the list of docs sharing source info.

Parameters

userID

The ID of the user who is sharing docs.

Returns

If the function succeeds, the return value is a pointer to the NSArray<ZoomSDKDocsSharingSourceInfo*>. Otherwise, the return value is nil.

getViewableSharingUserList

- (NSArray< NSNumber * > *_Nullable) getViewableSharingUserList

Get the ID of users who are sharing docs.

Returns

A list of userID of all users who are sharing docs.

isOtherSharingDocs

- (BOOL) isOtherSharingDocs

Query if other user is sharing docs.

Returns

YES means sharing.

isSharingDocsOut

- (BOOL) isSharingDocsOut

Query if the current user is sharing docs successfully.

Returns

YES means sharing successfully.

isSupportDocs

- (BOOL) isSupportDocs

Determine whether the current meeting supports docs or not.

Returns

YES indicates that the current meeting supports docs.

setDocsCreateOption:

- (ZoomSDKError) setDocsCreateOption:

(ZoomSDKDocsCreateOption)

option

Set the setting option for who can initiate new docs.

Parameters

option

Docs setting option for who can initiate new docs. For more details, see ZoomSDKDocsCreateOption.

Returns

If the function succeeds, it will return ZoomSDKError_Success.

setDocsShareOption:

- (ZoomSDKError) setDocsShareOption:

(ZoomSDKDocsShareOption)

option

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

Parameters

option

The setting for who can share docs. For more details, see ZoomSDKDocsShareOption.

Returns

If the function succeeds, it will return ZoomSDKError_Success.

setDocsWindowPos:

- (ZoomSDKError) setDocsWindowPos:

(NSPoint)

point

Set 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 the function fails.

Note

Only available for the custom UI.

setDocsWindowSize:

- (ZoomSDKError) setDocsWindowSize:

(NSSize)

size

Set 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 the function fails.

Note

Only available for the custom UI.

showDashboardWindow:

- (ZoomSDKError) showDashboardWindow:

(NSPoint)

point

Show 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 the function fails.

Note

Only available for the custom UI.

showDocsWindow:

- (ZoomSDKError) showDocsWindow:

(unsigned int)

shareSourceID

Show the docs web view window.

Parameters

shareSourceID

The share source ID that is sharing.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, the function fails.

Note

Only available for the custom UI.

Property Documentation

delegate

- (id<ZoomSDKMeetingDocsControllerDelegate>) delegate

readwritenonatomicassign

Definition at line 45 of file ZoomSDKMeetingDocsController.h.