6#import <Foundation/Foundation.h>
7#import <ZoomSDK/ZoomSDKErrors.h>
119@protocol ZoomSDKBOMeetingCreatorDelegate <NSObject>
127- (void)onBOCreateSuccess:(NSString *)boID DEPRECATED_MSG_ATTRIBUTE("Use -onCreateBOResponse:boID: instead");
146- (void)onCreateBOResponse:(BOOL)bSuccess boID:(NSString *)boID;
153- (void)onRemoveBOResponse:(BOOL)bSuccess boID:(NSString *)boID;
160- (void)onUpdateBONameResponse:(BOOL)bSuccess boID:(NSString *)boID;
171@property(nonatomic, assign, nullable)id<ZoomSDKBOMeetingCreatorDelegate>
delegate;
179- (BOOL)createBreakoutRoom:(NSString *)name;
187- (NSString *_Nullable)createBOWithBOName:(NSString*)name DEPRECATED_MSG_ATTRIBUTE("Use -createBreakoutRoom: instead");
194- (
ZoomSDKError)createBOWithBONameList:(NSArray<NSString *>*_Nullable)nameList;
202- (BOOL)createWebinarBO:(NSArray<NSString *>*)nameList DEPRECATED_MSG_ATTRIBUTE("Use createBreakoutRoom: instead");
233- (
ZoomSDKError)removeUserFromBO:(NSString *)userID BOID:(NSString *)ID;
272@protocol ZoomSDKBOMeetingAdminDelegate <NSObject>
278- (void)onHelpRequestReceived:(NSString *)userID;
291- (void)onBOEndTimerUpdated:(
unsigned int)remaining isTimesUpNotice:(BOOL)isTimesUpNotice;
297- (void)onStartBOResponse:(BOOL)bSuccess;
303- (void)onStopBOResponse:(BOOL)bSuccess;
314@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingAdminDelegate>
delegate;
333- (
ZoomSDKError)assignNewUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
341- (
ZoomSDKError)switchAssignedUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
423@protocol ZoomSDKBOMeetingAttendeeDelegate <NSObject>
452@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingAttendeeDelegate>
delegate;
495@protocol ZoomSDKBOMeetingDataHelpDelegate <NSObject>
502- (void)onBOMeetingInfoUpdated:(NSString *)boID;
525@property(nonatomic,assign,nullable)id<ZoomSDKBOMeetingDataHelpDelegate>
delegate;
544- (NSString *_Nullable)getBOUserNameWithUserID:(NSString *)userID;
558- (BOOL)isMyselfInBo:(NSString *)userid;
592@protocol ZoomSDKNewBreakoutRoomControllerDelegate <NSObject>
656- (void)onNewBroadcastMessageReceived:(NSString *)message senderUserId:(
unsigned int)userid senderName:(NSString*)senderName;
662- (void)onBOMeetingStopCountDown:(
unsigned int)countDown;
682- (void)onBOSwitchRequestReceived:(NSString*)newBOName newBOID:(NSString*_Nullable)newBOID;
688- (void)onBroadcastBOVoiceStatus:(BOOL)start;
709@property(nonatomic,assign,nullable)id<ZoomSDKNewBreakoutRoomControllerDelegate>
delegate;
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.