ZoomSDKNewBreakoutRoomController.h

Go to the documentation of this file.

 
#import <Foundation/Foundation.h>
#import <ZoomSDK/ZoomSDKErrors.h>
 
NS_ASSUME_NONNULL_BEGIN

@interface ZoomSDKBOMeetingInfo : NSObject

- (NSString *_Nullable)getBOID;

- (NSString *_Nullable)getBOName;

- (NSArray *_Nullable)getBOUserlist;

- (ZoomSDKBOUserStatus)getBOUserStatusWithUserID:(NSString *)userID;
@end
 

@interface ZoomSDKBOOption : NSObject

@property(nonatomic,assign)ZoomSDKBOStopCountDown  countDown;

@property(nonatomic,assign)BOOL  isParticipantCanChooseBO;

@property(nonatomic,assign)BOOL  isParticipantCanReturnToMainSessionAtAnyTime;

@property(nonatomic,assign)BOOL  isAutoMoveAllAssignedParticipantsEnabled;

@property(nonatomic,assign)BOOL  isBOTimerEnabled;

@property(nonatomic,assign)BOOL  isTimerAutoStopBOEnabled;

@property(nonatomic,assign)unsigned int  nTimerDurationMinutes;
 
//  WebinarBo
@property(nonatomic,assign) BOOL isAttendeeContained;

@property(nonatomic,assign) BOOL isPanelistCanChooseBO;

@property(nonatomic,assign) BOOL isAttendeeCanChooseBO;

@property(nonatomic,assign) BOOL isUserConfigMaxRoomUserLimitsEnabled;

@property(nonatomic,assign) unsigned int nUserConfigMaxRoomUserLimits;

@property(nonatomic,assign) BOOL isAICompanionEnabled;

@property(nonatomic,assign) BOOL isTranscriptionEnabled;
 
@end
 

@protocol ZoomSDKBOMeetingCreatorDelegate <NSObject>
@optional

- (void)onBOCreateSuccess:(NSString *)boID DEPRECATED_MSG_ATTRIBUTE("Use -onCreateBOResponse:boID: instead");

- (void)onWebPreAssignBODataDownloadStatusChanged:(ZoomSDKPreAssignBODataStatus)status;

- (void)onBOOptionChanged:(ZoomSDKBOOption*)newOption;

- (void)onCreateBOResponse:(BOOL)bSuccess boID:(NSString *)boID;

- (void)onRemoveBOResponse:(BOOL)bSuccess boID:(NSString *)boID;

- (void)onUpdateBONameResponse:(BOOL)bSuccess boID:(NSString *)boID;
@end

@interface ZoomSDKBOMeetingCreator : NSObject
@property(nonatomic, assign, nullable)id<ZoomSDKBOMeetingCreatorDelegate>  delegate;

- (BOOL)createBreakoutRoom:(NSString *)name;

- (NSString *_Nullable)createBOWithBOName:(NSString*)name DEPRECATED_MSG_ATTRIBUTE("Use -createBreakoutRoom: instead");

- (ZoomSDKError)createBOWithBONameList:(NSArray<NSString *>*_Nullable)nameList;

- (BOOL)createWebinarBO:(NSArray<NSString *>*)nameList DEPRECATED_MSG_ATTRIBUTE("Use createBreakoutRoom: instead");

- (ZoomSDKError)updateBOName:(NSString*)newName  BOID:(NSString *)ID;

- (ZoomSDKError)removeBO:(NSString*)BOID;

- (ZoomSDKError)assignUserToBO:(NSString *)userID  BOID:(NSString *)ID;

- (ZoomSDKError)removeUserFromBO:(NSString *)userID  BOID:(NSString *)ID;

- (ZoomSDKError)setBOOption:(ZoomSDKBOOption *_Nullable)boOption;

- (ZoomSDKBOOption *_Nullable)getBOOption;

- (BOOL)isWebPreAssignBOEnabled;

- (ZoomSDKError)requestAndUseWebPreAssignBOList;

- (ZoomSDKPreAssignBODataStatus)getWebPreAssignBODataStatus;

- (BOOL)isAICompanionSupported;

- (BOOL)isTranscriptionSupported;
@end
 

@protocol ZoomSDKBOMeetingAdminDelegate <NSObject>
@optional
- (void)onHelpRequestReceived:(NSString *)userID;

- (void)onStartBOError:(ZoomSDKBOControllerError)errCode;

- (void)onBOEndTimerUpdated:(unsigned int)remaining isTimesUpNotice:(BOOL)isTimesUpNotice;

- (void)onStartBOResponse:(BOOL)bSuccess;

- (void)onStopBOResponse:(BOOL)bSuccess;
@end

@interface ZoomSDKBOMeetingAdmin : NSObject
@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingAdminDelegate>  delegate;
- (ZoomSDKError)startBO;

- (ZoomSDKError)stopBO;

- (ZoomSDKError)assignNewUserToRunningBO:(NSString *)userID  BOID:(NSString *)ID;

- (ZoomSDKError)switchAssignedUserToRunningBO:(NSString *)userID  BOID:(NSString *)ID;

- (BOOL)canStartBO;

- (ZoomSDKError)joinBOByUserRequest:(NSString *)requestUserID;

- (ZoomSDKError)ignoreUserHelpRequest:(NSString *)userID;

- (ZoomSDKError)broadcastMessage:(NSString *)message;

- (ZoomSDKError)inviteBOUserReturnToMainSession:(NSString *)userID;

- (BOOL)isBroadcastVoiceToBOSupport;

- (BOOL)canBroadcastVoiceToBO;

- (ZoomSDKError)broadcastVoiceToBO:(BOOL)start;
@end
 

@interface ZoomSDKBOMeetingAssistant : NSObject

- (ZoomSDKError)joinBO:(NSString*)ID;

- (ZoomSDKError)leaveBO;
@end
 

@protocol ZoomSDKBOMeetingAttendeeDelegate <NSObject>
@optional
- (void)onHelpRequestHandleResultReceived:(ZoomSDKRequest4HelpResult)result;

- (void)onHostJoinedThisBOMeeting;

- (void)onHostLeaveThisBOMeeting;
 
@end
 

@interface ZoomSDKBOMeetingAttendee : NSObject
@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingAttendeeDelegate>  delegate;
- (ZoomSDKError)joinBO;

- (ZoomSDKError)leaveBO;

- (NSString*_Nullable)getBOName;

- (ZoomSDKError)requestForHelp;

- (BOOL)isHostInThisBO;

- (BOOL)isCanReturnMainSession;
 
@end

@protocol ZoomSDKBOMeetingDataHelpDelegate <NSObject>
@optional

- (void)onBOMeetingInfoUpdated:(NSString *)boID;

- (void)onUnAssignedUserUpdated;

- (void)onBOListInfoUpdated;
@end
 

@interface ZoomSDKBOMeetingDataHelp : NSObject

@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingDataHelpDelegate>  delegate;

- (NSArray *_Nullable)getUnassignedUserList;

- (NSArray *_Nullable)getBOMeetingIDList;

- (NSString *_Nullable)getBOUserNameWithUserID:(NSString *)userID;

- (ZoomSDKBOMeetingInfo *_Nullable)getBOMeetingInfoWithBOID:(NSString *)BOID;

- (BOOL)isMyselfInBo:(NSString *)userid;

- (NSString*_Nullable)getCurrentBoName;
@end
 

@interface ZoomSDKBOMeetingReturnToMainSessionHandler : NSObject

- (ZoomSDKError)returnToMainSession;

- (void)ignore;
 
@end
 

@protocol ZoomSDKNewBreakoutRoomControllerDelegate <NSObject>
@optional

- (void)onHasCreatorPermission:(ZoomSDKBOMeetingCreator *_Nullable)creatorObject;

- (void)onHasAdminPermission:(ZoomSDKBOMeetingAdmin *_Nullable)adminObject;

- (void)onHasAssistantPermission:(ZoomSDKBOMeetingAssistant *_Nullable)assistantObject;

- (void)onHasAttendeePermission:(ZoomSDKBOMeetingAttendee *_Nullable)attendeeObject;

- (void)onHasDataHelperPermission:(ZoomSDKBOMeetingDataHelp *_Nullable)dataHelpObject;

- (void)onLostCreatorPermission;

- (void)onLostAdminPermission;

- (void)onLostAssistantPermission;

- (void)onLostAttendeePermission;

- (void)onLostDataHelperPermission;

- (void)onNewBroadcastMessageReceived:(NSString *)message senderUserId:(unsigned int)userid senderName:(NSString*)senderName;

- (void)onBOMeetingStopCountDown:(unsigned int)countDown;

- (void)onHostInviteReturnToMainSession:(NSString*)userName handler:(ZoomSDKBOMeetingReturnToMainSessionHandler*)handler;

- (void)onBOControlStatusChanged:(ZoomSDKBOStatus)status;

- (void)onBOSwitchRequestReceived:(NSString*)newBOName newBOID:(NSString*_Nullable)newBOID;

- (void)onBroadcastBOVoiceStatus:(BOOL)start;

- (void)onShareFromMainSession:(unsigned int)sharingID status:(ZoomSDKShareStatus)status shareAction:(ZoomSDKShareAction *)shareAction;
@end
 
 

@interface ZoomSDKNewBreakoutRoomController : NSObject
@property(nonatomic,assign,nullable)id<ZoomSDKNewBreakoutRoomControllerDelegate>  delegate;

- (ZoomSDKBOMeetingCreator *_Nullable)getBOMeetingCreator;

- (ZoomSDKBOMeetingAdmin *_Nullable)getBOMeetingAdmin;

- (ZoomSDKBOMeetingAssistant *_Nullable)getBOMeetingAssistant;

- (ZoomSDKBOMeetingAttendee *_Nullable)getBOMeetingAttendee;

- (ZoomSDKBOMeetingDataHelp *_Nullable)getBOMeetingDataHelp;

- (BOOL)isBOStart;

- (BOOL)isBOEnable;

- (BOOL)isInBOMeeting;

- (ZoomSDKBOStatus)getBOStatus;

- (BOOL)isBroadcastingVoiceToBO;

- (NSString *_Nullable)getJoiningBOName;
@end
 
NS_ASSUME_NONNULL_END