Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKNewBreakoutRoomController.h
Go to the documentation of this file.
1
2#import <Foundation/Foundation.h>
3#import "ZoomSDKErrors.h"
4
5NS_ASSUME_NONNULL_BEGIN
6@interface ZoomSDKBOMeetingInfo : NSObject
7
12-(NSString *)getBOID;
13
18-(NSString *)getBOName;
19
24-(NSArray *)getBOUserlist;
25
31-(ZoomSDKBOUserStatus)getBOUserStatusWithUserID:(NSString *)userID;
32@end
33
34@interface ZoomSDKBOOption : NSObject
35
39@property(nonatomic,assign)ZoomSDKBOStopCountDown countDown;
40
44@property(nonatomic,assign)BOOL isParticipantCanChooseBO;
45
49@property(nonatomic,assign)BOOL isParticipantCanReturnToMainSessionAtAnyTime;
50
54@property(nonatomic,assign)BOOL isAutoMoveAllAssignedParticipantsEnabled;
55
59@property(nonatomic,assign)BOOL isBOTimerEnabled;
60
64@property(nonatomic,assign)BOOL isTimerAutoStopBOEnabled;
65
69@property(nonatomic,assign)unsigned int nTimerDuration;
70
71// WebinarBo
75@property(nonatomic,assign) BOOL isAttendeeContained;
76
80@property(nonatomic,assign) BOOL isPanelistCanChooseBO;
81
85@property(nonatomic,assign) BOOL isAttendeeCanChooseBO;
86
90@property(nonatomic,assign) BOOL isUserConfigMaxRoomUserLimitsEnabled;
91
95@property(nonatomic,assign)unsigned int nUserConfigMaxRoomUserLimits;
96
97@end
98
99@protocol ZoomSDKBOMeetingCreatorDelegate <NSObject>
100@optional
101
106-(void)onBOCreateSuccess:(NSString *)boID;
107
112-(void)onWebPreAssignBODataDownloadStatusChanged:(ZoomSDKPreAssignBODataStatus)status;
113
118-(void)onBOOptionChanged:(ZoomSDKBOOption*)newOption;
119@end
120
121@interface ZoomSDKBOMeetingCreator : NSObject
122
123@property(nonatomic,assign)id<ZoomSDKBOMeetingCreatorDelegate> delegate;
124
130-(NSString *)createBOWithBOName:(NSString*)name;
131
137-(ZoomSDKError)createBOWithBONameList:(NSArray<NSString *>*)nameList;
138
144- (BOOL)createWebinarBO:(NSArray<NSString *>*)nameList;
145
152-(ZoomSDKError)updateBOName:(NSString*)newName BOID:(NSString *)ID;
153
159-(ZoomSDKError)removeBO:(NSString*)BOID;
160
167-(ZoomSDKError)assignUserToBO:(NSString *)userID BOID:(NSString *)ID;
168
175-(ZoomSDKError)removeUserFromBO:(NSString *)userID BOID:(NSString *)ID;
176
182-(ZoomSDKError)setBOOption:(ZoomSDKBOOption *)boOption;
183
188-(ZoomSDKBOOption *)getBOOption;
189
194-(BOOL)isWebPreAssignBOEnabled;
195
200-(ZoomSDKError)requestAndUseWebPreAssignBOList;
201
206-(ZoomSDKPreAssignBODataStatus)getWebPreAssignBODataStatus;
207@end
208
209@protocol ZoomSDKBOMeetingAdminDelegate <NSObject>
210@optional
215-(void)onHelpRequestReceived:(NSString *)userID;
216
221-(void)onStartBOError:(ZoomSDKBOControllerError)errCode;
222
228-(void)onBOEndTimerUpdated:(unsigned int)remaining isTimesUpNotice:(BOOL)isTimesUpNotice;
229
230@end
231
232@interface ZoomSDKBOMeetingAdmin : NSObject
233
234@property(nonatomic,assign)id<ZoomSDKBOMeetingAdminDelegate> delegate;
239-(ZoomSDKError)startBO;
240
245-(ZoomSDKError)stopBO;
246
253-(ZoomSDKError)assignNewUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
254
261-(ZoomSDKError)switchAssignedUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
262
267-(BOOL)canStartBO;
268
274-(ZoomSDKError)joinBOByUserRequest:(NSString *)requestUserID;
275
281-(ZoomSDKError)ignoreUserHelpRequest:(NSString *)userID;
282
288-(ZoomSDKError)broadcastMessage:(NSString *)message;
289
295-(ZoomSDKError)inviteBOUserReturnToMainSession:(NSString *)userID;
296
301-(BOOL)isBroadcastVoiceToBOSupport;
302
307-(BOOL)canBroadcastVoiceToBO;
308
314-(ZoomSDKError)broadcastVoiceToBO:(BOOL)start;
315@end
316
317@interface ZoomSDKBOMeetingAssistant : NSObject
318
324-(ZoomSDKError)joinBO:(NSString*)ID;
325
330-(ZoomSDKError)leaveBO;
331@end
332
333@protocol ZoomSDKBOMeetingAttendeeDelegate <NSObject>
334@optional
339-(void)onHelpRequestHandleResultReceived:(ZoomSDKRequest4HelpResult)result;
340
344-(void)onHostJoinedThisBOMeeting;
345
349-(void)onHostLeaveThisBOMeeting;
350
351@end
352
353@interface ZoomSDKBOMeetingAttendee : NSObject
354
355@property(nonatomic,assign)id<ZoomSDKBOMeetingAttendeeDelegate> delegate;
360-(ZoomSDKError)joinBO;
361
366-(ZoomSDKError)leaveBO;
367
372-(NSString*)getBOName;
373
378-(ZoomSDKError)requestForHelp;
379
384-(BOOL)isHostInThisBO;
385
390-(BOOL)isCanReturnMainSession;
391
392@end
393
394@protocol ZoomSDKBOMeetingDataHelpDelegate <NSObject>
395@optional
396
401-(void)onBOMeetingInfoUpdata:(NSString *)boID DEPRECATED_MSG_ATTRIBUTE("Use -onBOMeetingInfoUpdated: instead");
402
407-(void)onBOMeetingInfoUpdated:(NSString *)boID;
408
412-(void)onUnAssignedUserUpdated;
413
417-(void)onBOListInfoUpdated;
418@end
419
420@interface ZoomSDKBOMeetingDataHelp : NSObject
421
425@property(nonatomic,assign)id<ZoomSDKBOMeetingDataHelpDelegate> delegate;
426
431-(NSArray *)getUnassignedUserList;
432
437-(NSArray *)getBOMeetingIDList;
438
444-(NSString *)getBOUserNameWithUserID:(NSString *)userID;
445
451-(ZoomSDKBOMeetingInfo *)getBOMeetingInfoWithBOID:(NSString *)BOID;
452
458-(BOOL)isMyselfInBo:(NSString *)userid;
459
464-(NSString*)getCurrentBoName;
465@end
466
468
473-(ZoomSDKError)returnToMainSession;
474
478-(void)ignore;
479
480@end
481
482@protocol ZoomSDKNewBreakoutRoomControllerDelegate <NSObject>
483@optional
484
489-(void)onHasCreatorPermission:(ZoomSDKBOMeetingCreator *)creatorObject;
490
495-(void)onHasAdminPermission:(ZoomSDKBOMeetingAdmin *)adminObject;
496
501-(void)onHasAssistantPermission:(ZoomSDKBOMeetingAssistant *)assistantObject;
502
507-(void)onHasAttendeePermission:(ZoomSDKBOMeetingAttendee *)attendeeObject;
508
513-(void)onHasDataHelperPermission:(ZoomSDKBOMeetingDataHelp *)dataHelpObject;
514
518-(void)onLostCreatorPermission;
519
523-(void)onLostAdminPermission;
524
528-(void)onLostAssistantPermission;
529
533-(void)onLostAttendeePermission;
534
538-(void)onLostDataHelperPermission;
539
545-(void)onNewBroadcastMessageReceived:(NSString *)message senderUserId:(unsigned int)userid DEPRECATED_MSG_ATTRIBUTE("Use -onNewBroadcastMessageReceived:senderUserId:senderName instead");
546
553-(void)onNewBroadcastMessageReceived:(NSString *)message senderUserId:(unsigned int)userid senderName:(NSString*)senderName;
558-(void)onBOStopCountDown:(ZoomSDKBOStopCountDown)countDown DEPRECATED_MSG_ATTRIBUTE("Use -onBOMeetingStopCountDown: instead");
559
564-(void)onBOMeetingStopCountDown:(unsigned int)countDown;
565
571-(void)onHostInviteReturnToMainSession:(NSString*)userName handler:(ZoomSDKBOMeetingReturnToMainSessionHandler*)handler;
572
577-(void)onBOControlStatusChanged:(ZoomSDKBOStatus)status;
578
584-(void)onBOSwitchRequestReceived:(NSString*)newBOName newBOID:(NSString*)newBOID;
585
590-(void)onBroadcastBOVoiceStatus:(BOOL)start;
591@end
592
594
595@property(nonatomic,assign)id<ZoomSDKNewBreakoutRoomControllerDelegate> delegate;
596
602-(ZoomSDKBOMeetingCreator *)getBOMeetingCreator;
603
609-(ZoomSDKBOMeetingAdmin *)getBOMeetingAdmin;
610
616-(ZoomSDKBOMeetingAssistant *)getBOMeetingAssistant;
617
623-(ZoomSDKBOMeetingAttendee *)getBOMeetingAttendee;
624
630-(ZoomSDKBOMeetingDataHelp *)getBOMeetingDataHelp;
631
636-(BOOL)isBOStart;
637
642-(BOOL)isBOEnable;
643
648-(BOOL)isInBOMeeting;
649
654-(ZoomSDKBOStatus)getBOStatus;
655
660-(BOOL)isBroadcastingVoiceToBO;
661
667-(NSString *)getJoiningBOName;
668@end
669
670NS_ASSUME_NONNULL_END
ZoomSDKBOUserStatus
Enumerations of breakout meeting status.
ZoomSDKBOStatus
Enum for BO status.
ZoomSDKPreAssignBODataStatus
ZoomSDKBOControllerError
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKRequest4HelpResult
Enumerations of attendee request for help result.
ZoomSDKBOStopCountDown
Enum for BO stop countdown.
NSString * getBOID()
Get breakout meeting id.
NSArray * getBOUserlist()
Get breakout meeting user list.
NSString * getBOName()
Get breakout meeting nmae.
ZoomSDKBOStopCountDown countDown
Set the countdown after closing breakout room.
BOOL isAutoMoveAllAssignedParticipantsEnabled
Enable/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/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/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.