ZoomSDKBOMeetingCreator Class Reference

Interface for creating and managing breakout rooms. More...

#include <ZoomSDKNewBreakoutRoomController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- createBreakoutRoom:
	Creates a breakout room.
(NSString *_Nullable)	- createBOWithBOName:
	Creator breakout meeting.
(ZoomSDKError)	- createBOWithBONameList:
	Creator breakout meeting in batch.
(BOOL)	- createWebinarBO:
	Creator webinar breakout meeting.
(ZoomSDKError)	- updateBOName:BOID:
	Updates breakout meeting information. '-onUpdateBONameResponse:boID:' is the corresponding callback notification.
(ZoomSDKError)	- removeBO:
	Removes breakout meeting by ID. '-onRemoveBOResponse:boID:' is the corresponding callback notification.
(ZoomSDKError)	- assignUserToBO:BOID:
	Assign user to Breakout meeting.
(ZoomSDKError)	- removeUserFromBO:BOID:
	Removed user from Breakout meeting.
(ZoomSDKError)	- setBOOption:
	Sets BO option.
(ZoomSDKBOOption *_Nullable)	- getBOOption
	Gets BO option.
(BOOL)	- isWebPreAssignBOEnabled
	Checks whether web enabled the pre-assigned option when scheduling a meeting.
(ZoomSDKError)	- requestAndUseWebPreAssignBOList
	Request web pre-assigned data and create those rooms.
(ZoomSDKPreAssignBODataStatus)	- getWebPreAssignBODataStatus
	Gets the downloading status of pre-assigned data.

Properties
id< ZoomSDKBOMeetingCreatorDelegate >	delegate
	Sets or get the delegate to receive breakout room creation callbacks.

Detailed Description

Interface for creating and managing breakout rooms.

Definition at line 167 of file ZoomSDKNewBreakoutRoomController.h.

Method Documentation

assignUserToBO:BOID:

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

Assign user to Breakout meeting.

Parameters

userID	Assigned user ID.
ID	Breakout meeting ID.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

createBOWithBOName:

- (NSString *_Nullable) createBOWithBOName:

(NSString *)

name

Creator breakout meeting.

Parameters

name	Breakout meeting name,should less than 50 characters.

Returns

If the function succeeds, it returns breakout meeting ID. Otherwise return nil,

Deprecated

Use ZoomSDKBOMeetingCreator::createBreakoutRoom: instead.

createBOWithBONameList:

- (ZoomSDKError) createBOWithBONameList:

(NSArray< NSString * > *_Nullable)

nameList

Creator breakout meeting in batch.

Parameters

nameList

Breakout meeting name list, the element of nameList should less than 50 characters.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

createBreakoutRoom:

- (BOOL) createBreakoutRoom:

(NSString *)

name

Creates a breakout room.

Parameters

name	The breakout room name.

Returns

If the function succeeds, it returns YES. Otherwise, NO.

Note

1. This function is compatible with meeting breakout rooms and webinar breakout rooms. 2. This function is asynchronous, onCreateBOResponse is the corresponding callback notification. 3. Webinar breakout room only support Zoomui Mode.

createWebinarBO:

- (BOOL) createWebinarBO:

(NSArray< NSString * > *)

nameList

Creator webinar breakout meeting.

Parameters

nameList

Breakout meeting name list, the element of nameList should less than 50 characters.

Returns

If the function succeeds, it returns YES. Otherwise, NO.

Deprecated

Use ZoomSDKBOMeetingCreator::createBreakoutRoom: instead.

getBOOption

- (ZoomSDKBOOption *_Nullable) getBOOption

Gets BO option.

Returns

If the function succeeds, it returns the bo option object. Otherwise, this function fails and returns nil.

References getBOOption.

Referenced by getBOOption.

getWebPreAssignBODataStatus

- (ZoomSDKPreAssignBODataStatus) getWebPreAssignBODataStatus

Gets the downloading status of pre-assigned data.

Returns

The web pre-assigned data download status.

References getWebPreAssignBODataStatus.

Referenced by getWebPreAssignBODataStatus.

isWebPreAssignBOEnabled

- (BOOL) isWebPreAssignBOEnabled

Checks whether web enabled the pre-assigned option when scheduling a meeting.

Returns

If return YES if enabled. Otherwise, NO.

References isWebPreAssignBOEnabled.

Referenced by isWebPreAssignBOEnabled.

removeBO:

- (ZoomSDKError) removeBO:

(NSString *)

BOID

Removes breakout meeting by ID. '-onRemoveBOResponse:boID:' is the corresponding callback notification.

Parameters

BOID	Need remove breakout meeting ID.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

removeUserFromBO:BOID:

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

Removed user from Breakout meeting.

Parameters

userID	Removed user ID.
ID	Breakout meeting ID.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

requestAndUseWebPreAssignBOList

- (ZoomSDKError) requestAndUseWebPreAssignBOList

Request web pre-assigned data and create those rooms.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References requestAndUseWebPreAssignBOList.

Referenced by requestAndUseWebPreAssignBOList.

setBOOption:

- (ZoomSDKError) setBOOption:

(ZoomSDKBOOption *_Nullable)

boOption

Sets BO option.

Parameters

boOption

The option that you want to set.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

updateBOName:BOID:

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

Updates breakout meeting information. '-onUpdateBONameResponse:boID:' is the corresponding callback notification.

Parameters

newName	Breakout meeting new name.
ID	Breakout meeting ID.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Property Documentation

delegate

- (id<ZoomSDKBOMeetingCreatorDelegate>) delegate

readwritenonatomicassign

Sets or get the delegate to receive breakout room creation callbacks.

Definition at line 171 of file ZoomSDKNewBreakoutRoomController.h.