MobileRTCBOCreator Class Reference

A class for creating and managing breakout rooms. More...

#include <MobileRTCBORole.h>

Inherits NSObject.

Instance Methods
(NSString *_Nullable)	- createBO:
	Creates a breakout meeting.
(BOOL)	- createBreakoutRoom:
	Creates a breakout room.
(BOOL)	- createGroupBO:
	Creates breakout meetings in batches.
(BOOL)	- createWebinarBO:
	Creates webinar breakout meeting. Available only for Zoom UI mode.
(BOOL)	- updateBO:name:
	Updates breakout meeting name with breakout room ID. The callback is 'onUpdateBONameResponse:BOID'.
(BOOL)	- removeBO:
	Removes a breakout meeting. The callback is 'onRemoveBOResponse:BOID:'.
(BOOL)	- assignUser:toBO:
	Assigns a user to a breakout meeting.
(BOOL)	- removeUser:fromBO:
	Removes a user from a breakout meeting.
(BOOL)	- setBOOption:
	Sets breakout room option.
(MobileRTCBOOption *_Nullable)	- getBOOption
	Gets breakout room option.
(BOOL)	- isWebPreAssignBOEnabled
	Checks whether web enabled the pre-assigned option when scheduling a meeting.
(MobileRTCSDKError)	- requestAndUseWebPreAssignBOList
	Requests web pre-assigned data and creates those rooms.
(MobileRTCBOPreAssignBODataStatus)	- getWebPreAssignBODataStatus
	Gets the downloading status of pre-assigned data.

Detailed Description

A class for creating and managing breakout rooms.

//////////////////////////// Creator ////////////////////////////

1. Main Functions: 1) create|delete|rename BO 2) assign|remove user to BO 3) set BO option
2. Remarks: 1) These editing can only be done before BO is started

//////////////////////////// Admin ////////////////////////////

1. Main Functions: 1) after BO is started, assign new user to BO, 2) after BO is started, switch user from BO-A to BO-B 3) stop BO 4) start BO

   //////////////////////////// Assistant ////////////////////////////

   1. Main Functions: 1) join BO with BO id 2) leave BO

//////////////////////////// Attendee ////////////////////////////

1. Main Functions: 1) join BO 2) leave BO 3) request help

   //////////////////////////// DataHelper ////////////////////////////

   1. Main Functions: 1) get unassigned user list 2) get BO list 3) get BO object

   host in master conference : creator + admin + assistant + dataHelper host in BO conference : admin + assistant + dataHelper CoHost in master conference : [attendee] or [creator + admin + assistant + dataHelper] CoHost in BO conference : [attendee] or [admin + assistant + dataHelper] attendee in master conference : attendee + [assistant + dataHelper] attendee in BO conference : attendee + [assistant + dataHelper]

Import Remarks:

1. attendee in master conference/attendee in BO conference 1) if BOOption.IsParticipantCanChooseBO is YES, attendee has objects: [attendee + assistant + dataHelper] 2) if BOOption.IsParticipantCanChooseBO is NO, attendee has object: [attendee]
2. CoHost in master conference 1) if CoHost is desktop client, and host is desktop client, the CoHost has objects: [creator + admin + assistant + dataHelper] 2) if CoHost is desktop client, and host is mobile client, the CoHost has object: [attendee] 3) if CoHost is mobile client, the CoHost has object: [attendee]

Definition at line 217 of file MobileRTCBORole.h.

Method Documentation

assignUser:toBO:

- (BOOL) assignUser:		(NSString *_Nonnull)	boUserId
toBO:		(NSString *_Nonnull)	boId

Assigns a user to a breakout meeting.

Parameters

boUserId	The breakout room user ID.
boId	The breakout room ID.

Returns

YES if assign succeeds. Otherwise, NO.

createBO:

- (NSString *_Nullable) createBO:

(NSString *_Nonnull)

boName

Creates a breakout meeting.

Parameters

boName

The breakout room name.

Returns

The breakout meeting ID.

Deprecated

Use createBreakoutRoom: instead.

createBreakoutRoom:

- (BOOL) createBreakoutRoom:

(NSString *_Nonnull)

boName

Creates a breakout room.

Parameters

boName

The breakout room name.

Returns

YES if the function succeeds. Otherwise, NO.

Note

1. This function is compatible with meeting breakout room and webinar breakout room.

2. This function is asynchronous. The callback is 'onCreateBOResponse:BOID:'.

3. Webinar breakout room is only supported in Zoom UI mode.

createGroupBO:

- (BOOL) createGroupBO:

(NSArray< NSString * > *_Nonnull)

boNameList

Creates breakout meetings in batches.

Parameters

boNameList

The breakout room name list.

Returns

YES if batch breakout room creation succeeds. Otherwise, NO.

createWebinarBO:

- (BOOL) createWebinarBO:

(NSArray< NSString * > *_Nonnull)

boNameList

Creates webinar breakout meeting. Available only for Zoom UI mode.

Parameters

boNameList

The breakout meeting name list. Each element of nameList should be less than 50 characters.

Returns

YES if the function succeeds. Otherwise, NO.

Deprecated

Use createBreakoutRoom: instead.

getBOOption

- (MobileRTCBOOption *_Nullable) getBOOption

Gets breakout room option.

Returns

The breakout room option value.

getWebPreAssignBODataStatus

- (MobileRTCBOPreAssignBODataStatus) getWebPreAssignBODataStatus

Gets the downloading status of pre-assigned data.

Returns

The download status.

isWebPreAssignBOEnabled

- (BOOL) isWebPreAssignBOEnabled

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

Returns

YES if it is enabled. Otherwise, NO.

removeBO:

- (BOOL) removeBO:

(NSString *_Nonnull)

boId

Removes a breakout meeting. The callback is 'onRemoveBOResponse:BOID:'.

Parameters

boId	The breakout room ID.

Returns

YES if remove breakout meeting succeeds. Otherwise, NO.

removeUser:fromBO:

- (BOOL) removeUser:		(NSString *_Nonnull)	boUserId
fromBO:		(NSString *_Nonnull)	boId

Removes a user from a breakout meeting.

Parameters

boUserId	The breakout room user ID.
boId	The breakout room ID.

Returns

YES if remove succeeds. Otherwise, NO.

requestAndUseWebPreAssignBOList

- (MobileRTCSDKError) requestAndUseWebPreAssignBOList

Requests web pre-assigned data and creates those rooms.

Returns

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

setBOOption:

- (BOOL) setBOOption:

(MobileRTCBOOption *_Nonnull)

option

Sets breakout room option.

Parameters

option

The option that you want to set.

Returns

YES if the function succeeds. Otherwise, NO.

updateBO:name:

- (BOOL) updateBO:		(NSString *_Nonnull)	boId
name:		(NSString *_Nonnull)	boName

Updates breakout meeting name with breakout room ID. The callback is 'onUpdateBONameResponse:BOID'.

Parameters

boId	The breakout room ID.
boName	The breakout room name.

Returns

YES if update succeeds. Otherwise, NO.