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
49@interface ZoomSDKBOOption : NSObject
50
54@property(nonatomic,assign)ZoomSDKBOStopCountDown countDown;
55
59@property(nonatomic,assign)BOOL isParticipantCanChooseBO;
60
64@property(nonatomic,assign)BOOL isParticipantCanReturnToMainSessionAtAnyTime;
65
69@property(nonatomic,assign)BOOL isAutoMoveAllAssignedParticipantsEnabled;
70
74@property(nonatomic,assign)BOOL isBOTimerEnabled;
75
79@property(nonatomic,assign)BOOL isTimerAutoStopBOEnabled;
80
84@property(nonatomic,assign)unsigned int nTimerDuration;
85
86// WebinarBo
90@property(nonatomic,assign) BOOL isAttendeeContained;
91
95@property(nonatomic,assign) BOOL isPanelistCanChooseBO;
96
100@property(nonatomic,assign) BOOL isAttendeeCanChooseBO;
101
105@property(nonatomic,assign) BOOL isUserConfigMaxRoomUserLimitsEnabled;
106
110@property(nonatomic,assign)unsigned int nUserConfigMaxRoomUserLimits;
111
112@end
113
114
119@protocol ZoomSDKBOMeetingCreatorDelegate <NSObject>
120@optional
121
127- (void)onBOCreateSuccess:(NSString *)boID DEPRECATED_MSG_ATTRIBUTE("Use -onCreateBOResponse:boID: instead");
128
133- (void)onWebPreAssignBODataDownloadStatusChanged:(ZoomSDKPreAssignBODataStatus)status;
134
139- (void)onBOOptionChanged:(ZoomSDKBOOption*)newOption;
140
146- (void)onCreateBOResponse:(BOOL)bSuccess boID:(NSString *)boID;
147
153- (void)onRemoveBOResponse:(BOOL)bSuccess boID:(NSString *)boID;
154
160- (void)onUpdateBONameResponse:(BOOL)bSuccess boID:(NSString *)boID;
161@end
162
167@interface ZoomSDKBOMeetingCreator : NSObject
171@property(nonatomic, assign, nullable)id<ZoomSDKBOMeetingCreatorDelegate> delegate;
172
179- (BOOL)createBreakoutRoom:(NSString *)name;
180
187- (NSString *_Nullable)createBOWithBOName:(NSString*)name DEPRECATED_MSG_ATTRIBUTE("Use -createBreakoutRoom: instead");
188
194- (ZoomSDKError)createBOWithBONameList:(NSArray<NSString *>*_Nullable)nameList;
195
202- (BOOL)createWebinarBO:(NSArray<NSString *>*)nameList DEPRECATED_MSG_ATTRIBUTE("Use createBreakoutRoom: instead");
203
210- (ZoomSDKError)updateBOName:(NSString*)newName BOID:(NSString *)ID;
211
217- (ZoomSDKError)removeBO:(NSString*)BOID;
218
225- (ZoomSDKError)assignUserToBO:(NSString *)userID BOID:(NSString *)ID;
226
233- (ZoomSDKError)removeUserFromBO:(NSString *)userID BOID:(NSString *)ID;
234
240- (ZoomSDKError)setBOOption:(ZoomSDKBOOption *_Nullable)boOption;
241
246- (ZoomSDKBOOption *_Nullable)getBOOption;
247
252- (BOOL)isWebPreAssignBOEnabled;
253
258- (ZoomSDKError)requestAndUseWebPreAssignBOList;
259
264- (ZoomSDKPreAssignBODataStatus)getWebPreAssignBODataStatus;
265@end
266
267
272@protocol ZoomSDKBOMeetingAdminDelegate <NSObject>
273@optional
278- (void)onHelpRequestReceived:(NSString *)userID;
279
284- (void)onStartBOError:(ZoomSDKBOControllerError)errCode;
285
291- (void)onBOEndTimerUpdated:(unsigned int)remaining isTimesUpNotice:(BOOL)isTimesUpNotice;
292
297- (void)onStartBOResponse:(BOOL)bSuccess;
298
303- (void)onStopBOResponse:(BOOL)bSuccess;
304@end
305
310@interface ZoomSDKBOMeetingAdmin : NSObject
314@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingAdminDelegate> delegate;
319- (ZoomSDKError)startBO;
320
325- (ZoomSDKError)stopBO;
326
333- (ZoomSDKError)assignNewUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
334
341- (ZoomSDKError)switchAssignedUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
342
347- (BOOL)canStartBO;
348
354- (ZoomSDKError)joinBOByUserRequest:(NSString *)requestUserID;
355
361- (ZoomSDKError)ignoreUserHelpRequest:(NSString *)userID;
362
368- (ZoomSDKError)broadcastMessage:(NSString *)message;
369
375- (ZoomSDKError)inviteBOUserReturnToMainSession:(NSString *)userID;
376
381- (BOOL)isBroadcastVoiceToBOSupport;
382
387- (BOOL)canBroadcastVoiceToBO;
388
394- (ZoomSDKError)broadcastVoiceToBO:(BOOL)start;
395@end
396
397
402@interface ZoomSDKBOMeetingAssistant : NSObject
403
409- (ZoomSDKError)joinBO:(NSString*)ID;
410
415- (ZoomSDKError)leaveBO;
416@end
417
418
423@protocol ZoomSDKBOMeetingAttendeeDelegate <NSObject>
424@optional
429- (void)onHelpRequestHandleResultReceived:(ZoomSDKRequest4HelpResult)result;
430
434- (void)onHostJoinedThisBOMeeting;
435
439- (void)onHostLeaveThisBOMeeting;
440
441@end
442
443
448@interface ZoomSDKBOMeetingAttendee : NSObject
452@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingAttendeeDelegate> delegate;
457- (ZoomSDKError)joinBO;
458
463- (ZoomSDKError)leaveBO;
464
469- (NSString*_Nullable)getBOName;
470
475- (ZoomSDKError)requestForHelp;
476
481- (BOOL)isHostInThisBO;
482
487- (BOOL)isCanReturnMainSession;
488
489@end
490
495@protocol ZoomSDKBOMeetingDataHelpDelegate <NSObject>
496@optional
497
502- (void)onBOMeetingInfoUpdated:(NSString *)boID;
503
507- (void)onUnAssignedUserUpdated;
508
512- (void)onBOListInfoUpdated;
513@end
514
515
520@interface ZoomSDKBOMeetingDataHelp : NSObject
521
525@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingDataHelpDelegate> delegate;
526
531- (NSArray *_Nullable)getUnassignedUserList;
532
537- (NSArray *_Nullable)getBOMeetingIDList;
538
544- (NSString *_Nullable)getBOUserNameWithUserID:(NSString *)userID;
545
551- (ZoomSDKBOMeetingInfo *_Nullable)getBOMeetingInfoWithBOID:(NSString *)BOID;
552
558- (BOOL)isMyselfInBo:(NSString *)userid;
559
564- (NSString*_Nullable)getCurrentBoName;
565@end
566
567
573
578- (ZoomSDKError)returnToMainSession;
579
583- (void)ignore;
584
585@end
586
587
592@protocol ZoomSDKNewBreakoutRoomControllerDelegate <NSObject>
593@optional
594
599- (void)onHasCreatorPermission:(ZoomSDKBOMeetingCreator *_Nullable)creatorObject;
600
605- (void)onHasAdminPermission:(ZoomSDKBOMeetingAdmin *_Nullable)adminObject;
606
611- (void)onHasAssistantPermission:(ZoomSDKBOMeetingAssistant *_Nullable)assistantObject;
612
617- (void)onHasAttendeePermission:(ZoomSDKBOMeetingAttendee *_Nullable)attendeeObject;
618
623- (void)onHasDataHelperPermission:(ZoomSDKBOMeetingDataHelp *_Nullable)dataHelpObject;
624
628- (void)onLostCreatorPermission;
629
633- (void)onLostAdminPermission;
634
638- (void)onLostAssistantPermission;
639
643- (void)onLostAttendeePermission;
644
648- (void)onLostDataHelperPermission;
649
656- (void)onNewBroadcastMessageReceived:(NSString *)message senderUserId:(unsigned int)userid senderName:(NSString*)senderName;
657
662- (void)onBOMeetingStopCountDown:(unsigned int)countDown;
663
669- (void)onHostInviteReturnToMainSession:(NSString*)userName handler:(ZoomSDKBOMeetingReturnToMainSessionHandler*)handler;
670
675- (void)onBOControlStatusChanged:(ZoomSDKBOStatus)status;
676
682- (void)onBOSwitchRequestReceived:(NSString*)newBOName newBOID:(NSString*_Nullable)newBOID;
683
688- (void)onBroadcastBOVoiceStatus:(BOOL)start;
689
696- (void)onShareFromMainSession:(unsigned int)sharingID status:(ZoomSDKShareStatus)status shareAction:(ZoomSDKShareAction *)shareAction;
697@end
698
699
700
709@property(nonatomic,assign,nullable)id<ZoomSDKNewBreakoutRoomControllerDelegate> delegate;
710
716- (ZoomSDKBOMeetingCreator *_Nullable)getBOMeetingCreator;
717
723- (ZoomSDKBOMeetingAdmin *_Nullable)getBOMeetingAdmin;
724
730- (ZoomSDKBOMeetingAssistant *_Nullable)getBOMeetingAssistant;
731
737- (ZoomSDKBOMeetingAttendee *_Nullable)getBOMeetingAttendee;
738
744- (ZoomSDKBOMeetingDataHelp *_Nullable)getBOMeetingDataHelp;
745
750- (BOOL)isBOStart;
751
756- (BOOL)isBOEnable;
757
762- (BOOL)isInBOMeeting;
763
768- (ZoomSDKBOStatus)getBOStatus;
769
774- (BOOL)isBroadcastingVoiceToBO;
775
781- (NSString *_Nullable)getJoiningBOName;
782@end
783
784NS_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.
A controller for managing breakout room operations as the admin.
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. For more information, please visit https://support....
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.