6#import <Foundation/Foundation.h>
7#import <ZoomSDK/ZoomSDKErrors.h>
118@protocol ZoomSDKBOMeetingCreatorDelegate <NSObject>
126- (void)onBOCreateSuccess:(NSString *)boID DEPRECATED_MSG_ATTRIBUTE("Use -onCreateBOResponse:boID: instead");
145- (void)onCreateBOResponse:(BOOL)bSuccess boID:(NSString *)boID;
152- (void)onRemoveBOResponse:(BOOL)bSuccess boID:(NSString *)boID;
159- (void)onUpdateBONameResponse:(BOOL)bSuccess boID:(NSString *)boID;
170@property(nonatomic, assign, nullable)id<ZoomSDKBOMeetingCreatorDelegate> delegate;
178- (BOOL)createBreakoutRoom:(NSString *)name;
186- (NSString *_Nullable)createBOWithBOName:(NSString*)name DEPRECATED_MSG_ATTRIBUTE(
"Use -createBreakoutRoom: instead");
193- (
ZoomSDKError)createBOWithBONameList:(NSArray<NSString *>*_Nullable)nameList;
200- (BOOL)createWebinarBO:(NSArray<NSString *>*)nameList;
208- (
ZoomSDKError)updateBOName:(NSString*)newName BOID:(NSString *)ID;
223- (
ZoomSDKError)assignUserToBO:(NSString *)userID BOID:(NSString *)ID;
231- (
ZoomSDKError)removeUserFromBO:(NSString *)userID BOID:(NSString *)ID;
250- (BOOL)isWebPreAssignBOEnabled;
269@protocol ZoomSDKBOMeetingAdminDelegate <NSObject>
275- (void)onHelpRequestReceived:(NSString *)userID;
288- (void)onBOEndTimerUpdated:(
unsigned int)remaining isTimesUpNotice:(BOOL)isTimesUpNotice;
294- (void)onStartBOResponse:(BOOL)bSuccess;
300- (void)onStopBOResponse:(BOOL)bSuccess;
307@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingAdminDelegate> delegate;
326- (
ZoomSDKError)assignNewUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
334- (
ZoomSDKError)switchAssignedUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
347- (
ZoomSDKError)joinBOByUserRequest:(NSString *)requestUserID;
354- (
ZoomSDKError)ignoreUserHelpRequest:(NSString *)userID;
368- (
ZoomSDKError)inviteBOUserReturnToMainSession:(NSString *)userID;
374- (BOOL)isBroadcastVoiceToBOSupport;
380- (BOOL)canBroadcastVoiceToBO;
415@protocol ZoomSDKBOMeetingAttendeeDelegate <NSObject>
426- (void)onHostJoinedThisBOMeeting;
431- (void)onHostLeaveThisBOMeeting;
444@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingAttendeeDelegate> delegate;
461- (NSString*_Nullable)getBOName;
473- (BOOL)isHostInThisBO;
479- (BOOL)isCanReturnMainSession;
486@protocol ZoomSDKBOMeetingDataHelpDelegate <NSObject>
493- (void)onBOMeetingInfoUpdated:(NSString *)boID;
498- (void)onUnAssignedUserUpdated;
503- (void)onBOListInfoUpdated;
516@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingDataHelpDelegate> delegate;
522- (NSArray *_Nullable)getUnassignedUserList;
528- (NSArray *_Nullable)getBOMeetingIDList;
535- (NSString *_Nullable)getBOUserNameWithUserID:(NSString *)userID;
549- (BOOL)isMyselfInBo:(NSString *)userid;
555- (NSString*_Nullable)getCurrentBoName;
583@protocol ZoomSDKNewBreakoutRoomControllerDelegate <NSObject>
619- (void)onLostCreatorPermission;
624- (void)onLostAdminPermission;
629- (void)onLostAssistantPermission;
634- (void)onLostAttendeePermission;
639- (void)onLostDataHelperPermission;
647- (void)onNewBroadcastMessageReceived:(NSString *)message senderUserId:(
unsigned int)userid senderName:(NSString*)senderName;
653- (void)onBOMeetingStopCountDown:(
unsigned int)countDown;
673- (void)onBOSwitchRequestReceived:(NSString*)newBOName newBOID:(NSString*_Nullable)newBOID;
679- (void)onBroadcastBOVoiceStatus:(BOOL)start;
700@property(nonatomic,assign,nullable)id<ZoomSDKNewBreakoutRoomControllerDelegate> delegate;
753- (BOOL)isInBOMeeting;
765- (BOOL)isBroadcastingVoiceToBO;
772- (NSString *_Nullable)getJoiningBOName;
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.