ZoomSDKBOMeetingCreator Class Reference

#include <ZoomSDKNewBreakoutRoomController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- createBreakoutRoom:
	Create 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:
	Update breakout meeting information. '-onUpdateBONameResponse:boID:' is the corresponding callback notification.
(ZoomSDKError)	- removeBO:
	Remove 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:
	Set BO option.
(ZoomSDKBOOption *_Nullable)	- getBOOption
	Get BO option.
(BOOL)	- isWebPreAssignBOEnabled
	Check whether web enabled the pre-assigned option when scheduling a meeting.
(ZoomSDKError)	- requestAndUseWebPreAssignBOList
	Request web pre-assigned data and create those rooms.
(ZoomSDKPreAssignBODataStatus)	- getWebPreAssignBODataStatus
	Get the downloading status of pre-assigned data.

Properties
id< ZoomSDKBOMeetingCreatorDelegate >	delegate

Detailed Description

Definition at line 143 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,will return ZoomSDKError_Success.

createBOWithBOName:

- (NSString *_Nullable) createBOWithBOName:

(NSString *)

name

Creator breakout meeting.

Parameters

name	Breakout meeting name,should less than 50 characters.

Returns

If the function succeeds,will return 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,will return ZoomSDKError_Success.

createBreakoutRoom:

- (BOOL) createBreakoutRoom:

(NSString *)

name

Create a breakout room.

Parameters

name	The breakout room name.

Returns

If the function succeeds,will return YES.

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,will return YES.

getBOOption

- (ZoomSDKBOOption *_Nullable) getBOOption

Get BO option.

Returns

The value is bo option object.

getWebPreAssignBODataStatus

- (ZoomSDKPreAssignBODataStatus) getWebPreAssignBODataStatus

Get the downloading status of pre-assigned data.

Returns

If the function succeeds, the return value is the web pre-assigned data download status. For more details, see ZoomSDKPreAssignBODataStatus.

isWebPreAssignBOEnabled

- (BOOL) isWebPreAssignBOEnabled

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

Returns

If return YES means enabled, otherwise not.

removeBO:

- (ZoomSDKError) removeBO:

(NSString *)

BOID

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

Parameters

BOID	Need remove breakout meeting ID.

Returns

If the function succeeds,will return ZoomSDKError_Success.

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,will return ZoomSDKError_Success.

requestAndUseWebPreAssignBOList

- (ZoomSDKError) requestAndUseWebPreAssignBOList

Request web pre-assigned data and create those rooms.

Returns

If the function succeeds, will return ZoomSDKError_Success.

setBOOption:

- (ZoomSDKError) setBOOption:

(ZoomSDKBOOption *_Nullable)

boOption

Set BO option.

Parameters

boOption

The option that you want to set.

Returns

If the function succeeds,will return ZoomSDKError_Success.

updateBOName:BOID:

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

Update 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,will return ZoomSDKError_Success.

Property Documentation

delegate

- (id<ZoomSDKBOMeetingCreatorDelegate>) delegate

readwritenonatomicassign

Definition at line 145 of file ZoomSDKNewBreakoutRoomController.h.