Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKMeetingDocsController.h
Go to the documentation of this file.
1
10
11#import <Foundation/Foundation.h>
12#import <ZoomSDK/ZoomSDKErrors.h>
13
14NS_ASSUME_NONNULL_BEGIN
15
20@interface ZoomSDKDocsSharingSourceInfo: NSObject
24@property(nonatomic, assign, readonly) unsigned int shareSourceID;
28@property(nonatomic, assign, readonly) unsigned int userID;
32@property(nonatomic, assign, readonly) ZoomSDKDocsStatus status;
36@property(nonatomic, copy, readonly) NSString *docTitle;
37@end
38
39
40
45@protocol ZoomSDKMeetingDocsControllerDelegate <NSObject>
50- (void)onDocsSharingSourceInfoChanged:(ZoomSDKDocsSharingSourceInfo *)shareSourceInfo;
51
57- (void)onDocsPermissionChanged:(ZoomSDKDocsCreateOption)createOption shareOption:(ZoomSDKDocsShareOption)shareOption;
58@end
59
60
65@interface ZoomSDKMeetingDocsController : NSObject
69@property(nonatomic,assign,nullable) id<ZoomSDKMeetingDocsControllerDelegate> delegate;
70
76
82- (BOOL)canStartShareDocs:(ZoomSDKCannotShareReasonType*)reason;
83
89
95
101
107- (ZoomSDKError)setDocsShareOption:(ZoomSDKDocsShareOption)option;
108
114
120- (ZoomSDKError)setDocsCreateOption:(ZoomSDKDocsCreateOption)option;
121
127
134- (ZoomSDKError)showDashboardWindow:(NSPoint)point;
135
142- (ZoomSDKError)setDocsWindowPos:(NSPoint)point;
143
150- (ZoomSDKError)setDocsWindowSize:(NSSize)size;
151
158- (ZoomSDKError)showDocsWindow:(unsigned int)shareSourceID;
159
166
171- (NSArray<NSNumber *>* _Nullable)getViewableSharingUserList;
172
178- (NSArray<ZoomSDKDocsSharingSourceInfo *>* _Nullable)getSharingSourceInfoList:(unsigned int)userID;
179@end
180
181NS_ASSUME_NONNULL_END
ZoomSDKDocsStatus
Enumeration of document sharing status in a meeting.
ZoomSDKCannotShareReasonType
Enumeration of reasons why sharing is not allowed.
ZoomSDKDocsCreateOption
Enumeration of document creation permission options.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKDocsShareOption
Enumeration of document sharing permission options.
Zoom Docs sharing source information class.
ZoomSDKDocsStatus status
Gets the status of Zoom docs sharing.
unsigned int userID
Gets the user ID of who is sharing Zoom docs.
unsigned int shareSourceID
Gets the share source ID of who is sharing Zoom docs.
NSString * docTitle
Gets the shared Zoom docs's title.
Zoom SDK meeting docs sharing controller.
BOOL isOtherSharingDocs()
Query if other user is sharing docs.
ZoomSDKDocsShareOption getDocsShareOption()
Gets the setting option indicating who can share documents.
BOOL isSharingDocsOut()
Query if the current user is sharing docs successfully.
BOOL canSetDocsOption()
Determines whether the current user can set docs options or not.
ZoomSDKDocsCreateOption getDocsCreateOption()
Gets the setting option indicating whether the user can initiate new docs.
BOOL isSupportDocs()
Determines whether the current meeting supports docs or not.
NSArray< NSNumber * > *_Nullable getViewableSharingUserList()
Gets the ID of users who are sharing docs.
ZoomSDKError closeDocsWindow()
Closes the docs web view window.
id< ZoomSDKMeetingDocsControllerDelegate > delegate
The delegate object to receive docs sharing events.