Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKNewBreakoutRoomController.h
Go to the documentation of this file.
1
5
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 nTimerDurationMinutes;
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
247
253
259
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;
320
326
333- (ZoomSDKError)assignNewUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
334
341- (ZoomSDKError)switchAssignedUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
342
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
382
388
394- (ZoomSDKError)broadcastVoiceToBO:(BOOL)start;
395@end
396
397
402@interface ZoomSDKBOMeetingAssistant : NSObject
403
409- (ZoomSDKError)joinBO:(NSString*)ID;
410
416@end
417
418
423@protocol ZoomSDKBOMeetingAttendeeDelegate <NSObject>
424@optional
429- (void)onHelpRequestHandleResultReceived:(ZoomSDKRequest4HelpResult)result;
430
435
440
441@end
442
443
448@interface ZoomSDKBOMeetingAttendee : NSObject
452@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingAttendeeDelegate> delegate;
458
464
469- (NSString*_Nullable)getBOName;
470
476
482
488
489@end
490
495@protocol ZoomSDKBOMeetingDataHelpDelegate <NSObject>
496@optional
497
502- (void)onBOMeetingInfoUpdated:(NSString *)boID;
503
508
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
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
629
634
639
644
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
717
724
731
738
745
750- (BOOL)isBOStart;
751
757
763
769
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.
BOOL canBroadcastVoiceToBO()
Query if the host now has the ability to broadcast voice to BO.
BOOL isBroadcastVoiceToBOSupport()
Query if the current meeting supports broadcasting host's voice to BO.
id< ZoomSDKBOMeetingAdminDelegate > delegate
Sets or get the delegate to receive breakout room admin callbacks.
ZoomSDKError stopBO()
Stops breakout meeting. '-onStopBOResponse:' is the corresponding callback notification.
ZoomSDKError startBO()
Starts breakout meeting. '-onStartBOResponse:' is the corresponding callback notification.
BOOL canStartBO()
Determines if the user can start breakout room.
Manages operations for joining and leaving breakout meetings as an assistant.
ZoomSDKError leaveBO()
Leave Breakout meeting.
Manages operations for attendees in breakout meetings.
BOOL isHostInThisBO()
Determines if the host is in this breakout room.
ZoomSDKError joinBO()
Join Breakout meeting.
ZoomSDKError leaveBO()
Leave breakout meeting.
ZoomSDKError requestForHelp()
Request for help when user in breakout room.
id< ZoomSDKBOMeetingAttendeeDelegate > delegate
Sets or get the delegate to receive breakout room attendee callbacks.
BOOL isCanReturnMainSession()
Determines if participant can return to main session.
NSString *_Nullable getBOName()
Gets breakout meeting name.
Interface for creating and managing breakout rooms.
ZoomSDKPreAssignBODataStatus getWebPreAssignBODataStatus()
Gets the downloading status of pre-assigned data.
ZoomSDKBOOption *_Nullable getBOOption()
Gets BO option.
BOOL isWebPreAssignBOEnabled()
Checks whether web enabled the pre-assigned option when scheduling a meeting.
id< ZoomSDKBOMeetingCreatorDelegate > delegate
Sets or get the delegate to receive breakout room creation callbacks.
ZoomSDKError requestAndUseWebPreAssignBOList()
Request web pre-assigned data and create those rooms.
Provides data helper functions for breakout meetings.
NSArray *_Nullable getBOMeetingIDList()
Gets breakout meeting ID list.
NSString *_Nullable getCurrentBoName()
Gets breakout meeting name.
NSArray *_Nullable getUnassignedUserList()
Gets unassigned user list.
id< ZoomSDKBOMeetingDataHelpDelegate > delegate
Sets or get the delegate to receive breakout room data helper callbacks.
Breakout room meeting information interface.
NSString *_Nullable getBOName()
Gets breakout meeting nmae.
NSArray *_Nullable getBOUserlist()
Gets breakout meeting user list.
NSString *_Nullable getBOID()
Gets breakout meeting ID.
Handler class to manage returning to main session from breakout meeting.
void ignore()
Ignore the return invitation, after call this api, please don't use the handler unless you receive th...
ZoomSDKError returnToMainSession()
Return to main session.
Defines breakout room configuration options. For more information, please visit https://support....
ZoomSDKBOStopCountDown countDown
Sets the countdown after closing breakout room.
BOOL isAutoMoveAllAssignedParticipantsEnabled
Enables or disable that auto move all assigned participants to breakout room.
BOOL isAttendeeCanChooseBO
Enables 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 if time is up, stops BO auto, NO otherwise.
unsigned int nTimerDurationMinutes
Minutes of BO timer duration, NOTE: when nTimerDurationMinutes is 0, it means that the BO duration is...
BOOL isParticipantCanReturnToMainSessionAtAnyTime
Enables or disable that participant can return to main session at any time.
BOOL isUserConfigMaxRoomUserLimitsEnabled
Enables or disable that max roomUser limits in BO room.
BOOL isParticipantCanChooseBO
Enables or disable that participant can choose breakout room.
BOOL isAttendeeContained
Enables or disable webinar attendee join webinar BO. When it changes, the BO data is reset.
BOOL isBOTimerEnabled
YES if it's timer BO, NO otherwise.
BOOL isPanelistCanChooseBO
Enables or disable that panelist can choose breakout room.
Controller class to manage breakout room features and permissions.
NSString *_Nullable getJoiningBOName()
Gets the BO's name you are going to.
ZoomSDKBOMeetingAssistant *_Nullable getBOMeetingAssistant()
Gets ZoomSDKBOMeetingAssistant Class object.
ZoomSDKBOStatus getBOStatus()
Gets current BO status.
BOOL isInBOMeeting()
Determines if user is in breakout meeting.
ZoomSDKBOMeetingDataHelp *_Nullable getBOMeetingDataHelp()
Gets ZoomSDKBOMeetingDataHelp Class object.
BOOL isBOStart()
Determines if breakout meeting is start.
BOOL isBOEnable()
Determines if breakout meeting is enable.
BOOL isBroadcastingVoiceToBO()
Query if the host is broadcasting voice to BO.
id< ZoomSDKNewBreakoutRoomControllerDelegate > delegate
Delegate to receive breakout room controller callbacks.
ZoomSDKBOMeetingAdmin *_Nullable getBOMeetingAdmin()
Gets ZoomSDKBOMeetingAdmin Class object.
ZoomSDKBOMeetingAttendee *_Nullable getBOMeetingAttendee()
Gets ZoomSDKBOMeetingAttendee Class object.
ZoomSDKBOMeetingCreator *_Nullable getBOMeetingCreator()
Gets ZoomSDKBOMeetingCreator Class object.
Representing a share action, including subscription and rendering controls.
void onHostLeaveThisBOMeeting()
Notify the host leave current breakout room.
void onHostJoinedThisBOMeeting()
Notify the host join current breakout room.
void onBOListInfoUpdated()
If breakout meeting list changed, receives the callback.
void onUnAssignedUserUpdated()
If the unassigned user changed, receives the callback.
void onLostCreatorPermission()
If lost creator's permissions change, receives the callback.
void onLostDataHelperPermission()
If lost dataHelper's permissions change, receives the callback.
void onLostAttendeePermission()
If lost attendee's permissions change, receives the callback.
void onLostAdminPermission()
If lost admin's permissions change, receives the callback.
void onLostAssistantPermission()
If lost assistant's permissions change, receives the callback.