Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingService+Whiteboard.h
Go to the documentation of this file.
1//
2// MobileRTCMeetingService+Whiteboard.h
3// MobileRTC
4//
5// Created by Zoom Communications on 2023/11/23.
6// Copyright © Zoom Communications, Inc. All rights reserved.
7//
8
9#import <MobileRTC/MobileRTC.h>
10
14@interface MobileRTCMeetingService (Whiteboard)
15
21
27
35- (MobileRTCSDKError)setParentViewCtroller:(UIViewController* _Nonnull)parentVC DEPRECATED_MSG_ATTRIBUTE("Not maintain anymore,Use showWhiteboardByParentViewCtroller instead");
36
43- (MobileRTCSDKError)showWhiteboardByParentViewCtroller:(UIViewController* _Nonnull)parentVC;
44
51
57
63- (MobileRTCSDKError)setWhiteboardShareOption:(MobileRTCWhiteboardShareOption)option;
64
70
76- (MobileRTCSDKError)setWhiteboardCreateOption:(MobileRTCWhiteboardCreateOption)option;
77
83
89- (MobileRTCSDKError)enableParticipantsCreateWithoutHost:(BOOL)enable;
90
96
97#pragma mark - UI setting -
103- (void)disableCloudWhiteboard:(BOOL)disabled;
104
110- (BOOL)setCloudWhiteboardFeedbackUrl:(nullable NSString *)feedbackUrl;
111
116- (void)hideCloudWhiteboardHelperCenterButton:(BOOL)hide;
117
122- (void)hideCloudWhiteboardOpenInBrowserButton:(BOOL)hide;
123
128- (void)hideFeedbackButtonOnCloudWhiteboard:(BOOL)hide;
129
134- (void)hideShareButtonOnCloudWhiteboard:(BOOL)hide;
135
140- (void)hideAboutButtonOnCloudWhiteboard:(BOOL)hide;
141
142#pragma mark - legal related -
148
153- (NSString *_Nullable)getWhiteboardLegalNoticesPrompt;
154
159- (NSString *_Nullable)getWhiteboardLegalNoticesExplained;
160
166
172@end
173
MobileRTCSDKError
Enumeration of SDK error.
MobileRTCCannotShareReasonType
Enumeration of reasons why sharing is not allowed.
MobileRTCWhiteboardShareOption
Enumeration of the whiteboard share options.
MobileRTCWhiteboardCreateOption
Enumeration of the whiteboard create options.
BOOL isWhiteboardLegalNoticeAvailable()
Is whiteboard legal notice available.
BOOL isOtherSharingWhiteboard()
If other user is sharing whiteboard.
NSString *_Nullable getWhiteboardLegalNoticesPrompt()
Get whiteboard legal notices message.
BOOL isSharingWhiteboardOut()
If the current user is sharing whiteboard.
void dismissWhiteboardOrDashboard()
Dismiss Whiteboard or Dashboard.
MobileRTCSDKError showDashboardView()
Show the dashboard web view window.
MobileRTCCannotShareReasonType canStartShareWhiteboard()
Determine whether the current meeting can start sharing the whiteboard.
BOOL isParticipantsCreateWithoutHostEnabled()
Determine whether enable the participants create a new whiteboard without the host in the meeting.
MobileRTCWhiteboardShareOption getWhiteboardShareOption()
Get the option for who can share a whiteboard.
BOOL isSupportWhiteBoard()
Determine whether the current meeting supports the whiteboard or not.
MobileRTCWhiteboardCreateOption getWhiteboardCreateOption()
Get the option for who can initiate a new whiteboard.
NSString *_Nullable getWhiteboardLegalNoticesExplained()
Get whiteboard legal notices detailed description.