|
Meeting SDK for macOS API 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. | |
Zoom SDK meeting docs sharing controller.
Definition at line 65 of file ZoomSDKMeetingDocsController.h.
| - (BOOL) canSetDocsOption |
Determines whether the current user can set docs options or not.
References canSetDocsOption.
Referenced by canSetDocsOption.
| - (BOOL) canStartShareDocs: | (ZoomSDKCannotShareReasonType *) | reason |
Determines whether the current user can start sharing the docs or not.
| reason | The reason why no one can start sharing the docs. |
| - (ZoomSDKError) closeDocsWindow |
Closes the docs web view window.
ZoomSDKError_Success. Otherwise, this function returns an error. References closeDocsWindow.
Referenced by closeDocsWindow.
| - (ZoomSDKDocsCreateOption) getDocsCreateOption |
Gets the setting option indicating whether the user can initiate new docs.
References getDocsCreateOption.
Referenced by getDocsCreateOption.
| - (ZoomSDKDocsShareOption) getDocsShareOption |
Gets the setting option indicating who can share documents.
References getDocsShareOption.
Referenced by getDocsShareOption.
| - (NSArray< ZoomSDKDocsSharingSourceInfo * > *_Nullable) getSharingSourceInfoList: | (unsigned int) | userID |
Gets the list of docs sharing source info.
| userID | The user's ID who is sharing docs. |
| - (NSArray< NSNumber * > *_Nullable) getViewableSharingUserList |
Gets the ID of users who are sharing docs.
References getViewableSharingUserList.
Referenced by getViewableSharingUserList.
| - (BOOL) isOtherSharingDocs |
Query if other user is sharing docs.
References isOtherSharingDocs.
Referenced by isOtherSharingDocs.
| - (BOOL) isSharingDocsOut |
Query if the current user is sharing docs successfully.
References isSharingDocsOut.
Referenced by isSharingDocsOut.
| - (BOOL) isSupportDocs |
Determines whether the current meeting supports docs or not.
References isSupportDocs.
Referenced by isSupportDocs.
| - (ZoomSDKError) setDocsCreateOption: | (ZoomSDKDocsCreateOption) | option |
Sets the setting option for who can initiate new docs.
| option | Docs setting option for who can initiate new docs. |
| - (ZoomSDKError) setDocsShareOption: | (ZoomSDKDocsShareOption) | option |
Sets the docs'setting option for who can share docs.
| option | The setting for who can share docs. |
| - (ZoomSDKError) setDocsWindowPos: | (NSPoint) | point |
Sets the docs web view window position.
| point | The original point to display docs web view window. Default is (0,0). |
ZoomSDKError_Success. Otherwise, this function returns an error. | - (ZoomSDKError) setDocsWindowSize: | (NSSize) | size |
Sets the docs web view window size.
| size | The size of display docs web view window. If the size is (0,0), the window size will be default size. |
ZoomSDKError_Success. Otherwise, this function returns an error. | - (ZoomSDKError) showDashboardWindow: | (NSPoint) | point |
Shows the dashboardView web view window.
| point | The original point to display dashboard web view window. Default is (0,0). |
ZoomSDKError_Success. Otherwise, this function returns an error. | - (ZoomSDKError) showDocsWindow: | (unsigned int) | shareSourceID |
Shows the docs web view window.
| shareSourceID | The share source ID that is sharing. |
ZoomSDKError_Success. Otherwise, this function returns an error.
|
readwritenonatomicassign |
The delegate object to receive docs sharing events.
Definition at line 69 of file ZoomSDKMeetingDocsController.h.