Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKNewBreakoutRoomController.h
Go to the documentation of this file.
1
6#import <Foundation/Foundation.h>
7#import <ZoomSDK/ZoomSDKErrors.h>
8
9NS_ASSUME_NONNULL_BEGIN
10
15@interface ZoomSDKBOMeetingInfo : NSObject
16
21- (NSString *_Nullable)getBOID;
22
27- (NSString *_Nullable)getBOName;
28
33- (NSArray *_Nullable)getBOUserlist;
34
40- (ZoomSDKBOUserStatus)getBOUserStatusWithUserID:(NSString *)userID;
41@end
42
43
48@interface ZoomSDKBOOption : NSObject
49
53@property(nonatomic,assign)ZoomSDKBOStopCountDown countDown;
54
58@property(nonatomic,assign)BOOL isParticipantCanChooseBO;
59
63@property(nonatomic,assign)BOOL isParticipantCanReturnToMainSessionAtAnyTime;
64
68@property(nonatomic,assign)BOOL isAutoMoveAllAssignedParticipantsEnabled;
69
73@property(nonatomic,assign)BOOL isBOTimerEnabled;
74
78@property(nonatomic,assign)BOOL isTimerAutoStopBOEnabled;
79
83@property(nonatomic,assign)unsigned int nTimerDuration;
84
85// WebinarBo
89@property(nonatomic,assign) BOOL isAttendeeContained;
90
94@property(nonatomic,assign) BOOL isPanelistCanChooseBO;
95
99@property(nonatomic,assign) BOOL isAttendeeCanChooseBO;
100
104@property(nonatomic,assign) BOOL isUserConfigMaxRoomUserLimitsEnabled;
105
109@property(nonatomic,assign)unsigned int nUserConfigMaxRoomUserLimits;
110
111@end
112
113
118@protocol ZoomSDKBOMeetingCreatorDelegate <NSObject>
119@optional
120
126- (void)onBOCreateSuccess:(NSString *)boID DEPRECATED_MSG_ATTRIBUTE("Use -onCreateBOResponse:boID: instead");
127
132- (void)onWebPreAssignBODataDownloadStatusChanged:(ZoomSDKPreAssignBODataStatus)status;
133
138- (void)onBOOptionChanged:(ZoomSDKBOOption*)newOption;
139
145- (void)onCreateBOResponse:(BOOL)bSuccess boID:(NSString *)boID;
146
152- (void)onRemoveBOResponse:(BOOL)bSuccess boID:(NSString *)boID;
153
159- (void)onUpdateBONameResponse:(BOOL)bSuccess boID:(NSString *)boID;
160@end
161
166@interface ZoomSDKBOMeetingCreator : NSObject
170@property(nonatomic, assign, nullable)id<ZoomSDKBOMeetingCreatorDelegate> delegate;
171
178- (BOOL)createBreakoutRoom:(NSString *)name;
179
186- (NSString *_Nullable)createBOWithBOName:(NSString*)name DEPRECATED_MSG_ATTRIBUTE("Use -createBreakoutRoom: instead");
187
193- (ZoomSDKError)createBOWithBONameList:(NSArray<NSString *>*_Nullable)nameList;
194
200- (BOOL)createWebinarBO:(NSArray<NSString *>*)nameList;
201
208- (ZoomSDKError)updateBOName:(NSString*)newName BOID:(NSString *)ID;
209
215- (ZoomSDKError)removeBO:(NSString*)BOID;
216
223- (ZoomSDKError)assignUserToBO:(NSString *)userID BOID:(NSString *)ID;
224
231- (ZoomSDKError)removeUserFromBO:(NSString *)userID BOID:(NSString *)ID;
232
238- (ZoomSDKError)setBOOption:(ZoomSDKBOOption *_Nullable)boOption;
239
244- (ZoomSDKBOOption *_Nullable)getBOOption;
245
250- (BOOL)isWebPreAssignBOEnabled;
251
256- (ZoomSDKError)requestAndUseWebPreAssignBOList;
257
262- (ZoomSDKPreAssignBODataStatus)getWebPreAssignBODataStatus;
263@end
264
265
269@protocol ZoomSDKBOMeetingAdminDelegate <NSObject>
270@optional
275- (void)onHelpRequestReceived:(NSString *)userID;
276
281- (void)onStartBOError:(ZoomSDKBOControllerError)errCode;
282
288- (void)onBOEndTimerUpdated:(unsigned int)remaining isTimesUpNotice:(BOOL)isTimesUpNotice;
289
294- (void)onStartBOResponse:(BOOL)bSuccess;
295
300- (void)onStopBOResponse:(BOOL)bSuccess;
301@end
302
303@interface ZoomSDKBOMeetingAdmin : NSObject
307@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingAdminDelegate> delegate;
312- (ZoomSDKError)startBO;
313
318- (ZoomSDKError)stopBO;
319
326- (ZoomSDKError)assignNewUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
327
334- (ZoomSDKError)switchAssignedUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
335
340- (BOOL)canStartBO;
341
347- (ZoomSDKError)joinBOByUserRequest:(NSString *)requestUserID;
348
354- (ZoomSDKError)ignoreUserHelpRequest:(NSString *)userID;
355
361- (ZoomSDKError)broadcastMessage:(NSString *)message;
362
368- (ZoomSDKError)inviteBOUserReturnToMainSession:(NSString *)userID;
369
374- (BOOL)isBroadcastVoiceToBOSupport;
375
380- (BOOL)canBroadcastVoiceToBO;
381
387- (ZoomSDKError)broadcastVoiceToBO:(BOOL)start;
388@end
389
390
395@interface ZoomSDKBOMeetingAssistant : NSObject
396
402- (ZoomSDKError)joinBO:(NSString*)ID;
403
408- (ZoomSDKError)leaveBO;
409@end
410
411
415@protocol ZoomSDKBOMeetingAttendeeDelegate <NSObject>
416@optional
421- (void)onHelpRequestHandleResultReceived:(ZoomSDKRequest4HelpResult)result;
422
426- (void)onHostJoinedThisBOMeeting;
427
431- (void)onHostLeaveThisBOMeeting;
432
433@end
434
435
440@interface ZoomSDKBOMeetingAttendee : NSObject
444@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingAttendeeDelegate> delegate;
449- (ZoomSDKError)joinBO;
450
455- (ZoomSDKError)leaveBO;
456
461- (NSString*_Nullable)getBOName;
462
467- (ZoomSDKError)requestForHelp;
468
473- (BOOL)isHostInThisBO;
474
479- (BOOL)isCanReturnMainSession;
480
481@end
482
486@protocol ZoomSDKBOMeetingDataHelpDelegate <NSObject>
487@optional
488
493- (void)onBOMeetingInfoUpdated:(NSString *)boID;
494
498- (void)onUnAssignedUserUpdated;
499
503- (void)onBOListInfoUpdated;
504@end
505
506
511@interface ZoomSDKBOMeetingDataHelp : NSObject
512
516@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingDataHelpDelegate> delegate;
517
522- (NSArray *_Nullable)getUnassignedUserList;
523
528- (NSArray *_Nullable)getBOMeetingIDList;
529
535- (NSString *_Nullable)getBOUserNameWithUserID:(NSString *)userID;
536
542- (ZoomSDKBOMeetingInfo *_Nullable)getBOMeetingInfoWithBOID:(NSString *)BOID;
543
549- (BOOL)isMyselfInBo:(NSString *)userid;
550
555- (NSString*_Nullable)getCurrentBoName;
556@end
557
558
564
569- (ZoomSDKError)returnToMainSession;
570
574- (void)ignore;
575
576@end
577
578
583@protocol ZoomSDKNewBreakoutRoomControllerDelegate <NSObject>
584@optional
585
590- (void)onHasCreatorPermission:(ZoomSDKBOMeetingCreator *_Nullable)creatorObject;
591
596- (void)onHasAdminPermission:(ZoomSDKBOMeetingAdmin *_Nullable)adminObject;
597
602- (void)onHasAssistantPermission:(ZoomSDKBOMeetingAssistant *_Nullable)assistantObject;
603
608- (void)onHasAttendeePermission:(ZoomSDKBOMeetingAttendee *_Nullable)attendeeObject;
609
614- (void)onHasDataHelperPermission:(ZoomSDKBOMeetingDataHelp *_Nullable)dataHelpObject;
615
619- (void)onLostCreatorPermission;
620
624- (void)onLostAdminPermission;
625
629- (void)onLostAssistantPermission;
630
634- (void)onLostAttendeePermission;
635
639- (void)onLostDataHelperPermission;
640
647- (void)onNewBroadcastMessageReceived:(NSString *)message senderUserId:(unsigned int)userid senderName:(NSString*)senderName;
648
653- (void)onBOMeetingStopCountDown:(unsigned int)countDown;
654
660- (void)onHostInviteReturnToMainSession:(NSString*)userName handler:(ZoomSDKBOMeetingReturnToMainSessionHandler*)handler;
661
666- (void)onBOControlStatusChanged:(ZoomSDKBOStatus)status;
667
673- (void)onBOSwitchRequestReceived:(NSString*)newBOName newBOID:(NSString*_Nullable)newBOID;
674
679- (void)onBroadcastBOVoiceStatus:(BOOL)start;
680
687- (void)onShareFromMainSession:(unsigned int)sharingID status:(ZoomSDKShareStatus)status shareAction:(ZoomSDKShareAction *)shareAction;
688@end
689
690
691
700@property(nonatomic,assign,nullable)id<ZoomSDKNewBreakoutRoomControllerDelegate> delegate;
701
707- (ZoomSDKBOMeetingCreator *_Nullable)getBOMeetingCreator;
708
714- (ZoomSDKBOMeetingAdmin *_Nullable)getBOMeetingAdmin;
715
721- (ZoomSDKBOMeetingAssistant *_Nullable)getBOMeetingAssistant;
722
728- (ZoomSDKBOMeetingAttendee *_Nullable)getBOMeetingAttendee;
729
735- (ZoomSDKBOMeetingDataHelp *_Nullable)getBOMeetingDataHelp;
736
741- (BOOL)isBOStart;
742
747- (BOOL)isBOEnable;
748
753- (BOOL)isInBOMeeting;
754
759- (ZoomSDKBOStatus)getBOStatus;
760
765- (BOOL)isBroadcastingVoiceToBO;
766
772- (NSString *_Nullable)getJoiningBOName;
773@end
774
775NS_ASSUME_NONNULL_END
ZoomSDKShareStatus
Enumeration of sharing status.
ZoomSDKBOUserStatus
Enumeration of breakout meeting user status.
ZoomSDKBOStatus
Enumeration of Breakout Room (BO) status.
ZoomSDKPreAssignBODataStatus
Enumeration of the pre-assign breakout room data download status.
ZoomSDKBOControllerError
Enumeration of the errors related to the Breakout Room (BO) controller operations.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKRequest4HelpResult
Enumeration of attendee request for help results.
ZoomSDKBOStopCountDown
Enumeration of Breakout Room (BO) stop countdown durations.
Manages operations for joining and leaving breakout meetings as an assistant.
Manages operations for attendees in breakout meetings.
Interface for creating and managing breakout rooms.
Provides data helper functions for breakout meetings.
Breakout Room meeting information interface.
NSString *_Nullable getBOName()
Get breakout meeting nmae.
NSArray *_Nullable getBOUserlist()
Get breakout meeting user list.
NSString *_Nullable getBOID()
Get breakout meeting id.
Handler class to manage returning to main session from breakout meeting.
Defines breakout room configuration options.
ZoomSDKBOStopCountDown countDown
Set the countdown after closing breakout room.
BOOL isAutoMoveAllAssignedParticipantsEnabled
Enable or disable that auto move all assigned participants to breakout room.
BOOL isAttendeeCanChooseBO
Enable or disable that Attendee can choose breakout room, invalid when attendee is not contained.
unsigned int nUserConfigMaxRoomUserLimits
Numbers of max roomUser limits in BO room, default is 20.
BOOL isTimerAutoStopBOEnabled
YES means time is up, will stop BO auto, otherwise not.
BOOL isParticipantCanReturnToMainSessionAtAnyTime
Enable or disable that participant can return to main session at any time.
BOOL isUserConfigMaxRoomUserLimitsEnabled
Enable or disable that max roomUser limits in BO room.
unsigned int nTimerDuration
Seconds of BO timer duration, NOTE: when nTimerDuration is 0, it means that the BO duration is 30*60 ...
BOOL isParticipantCanChooseBO
Enable or disable that participant can choose breakout room.
BOOL isAttendeeContained
Enable or disable webinar attendee join webinar BO. When it changes, the BO data will be reset.
BOOL isBOTimerEnabled
YES means it's timer BO, otherwise not.
BOOL isPanelistCanChooseBO
Enable or disable that panelist can choose breakout room.
Controller class to manage breakout room features and permissions.
Representing a share action, including subscription and rendering controls.