MobileRTCBOCreator Class Reference

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

#include <MobileRTCBORole.h>

Inherits NSObject.

Instance Methods
(NSString *_Nullable)	- createBO:
	Create a bo meeting.
(BOOL)	- createBreakoutRoom:
	Create a breakout room.
(BOOL)	- createGroupBO:
	Create bo meetings in batches.
(BOOL)	- createWebinarBO:
	Creator webinar breakout meeting, available only For Zoomui Mode.
(BOOL)	- updateBO:name:
	Update bo meeting name with bo id, the callback is: 'onUpdateBONameResponse:BOID'.
(BOOL)	- removeBO:
	Remove a bo meeting, the callback is: 'onRemoveBOResponse:BOID:'.
(BOOL)	- assignUser:toBO:
	Assign a user to a bo meeting.
(BOOL)	- removeUser:fromBO:
	Remove a user from a bo meeting.
(BOOL)	- setBOOption:
	Set BO option.
(MobileRTCBOOption *_Nullable)	- getBOOption
	Get BO option.
(BOOL)	- isWebPreAssignBOEnabled
	Check whether web enabled the pre-assigned option when scheduling a meeting.
(MobileRTCSDKError)	- requestAndUseWebPreAssignBOList
	Request web pre-assigned data and create those rooms.
(MobileRTCBOPreAssignBODataStatus)	- getWebPreAssignBODataStatus
	Get the downloading status of pre-assigned data.

Detailed Description

Interface 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 206 of file MobileRTCBORole.h.

Method Documentation

assignUser:toBO:

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

Assign a user to a bo meeting.

Parameters

boUserId	the BO user id.
boId	the BO id.

Returns

Assign success or not.

createBO:

- (NSString *_Nullable) createBO:

(NSString *_Nonnull)

boName

Create a bo meeting.

Parameters

boName

the BO name.

Returns

Bo meeting id.

Deprecated

Use createBreakoutRoom: instead.

createBreakoutRoom:

- (BOOL) createBreakoutRoom:

(NSString *_Nonnull)

boName

Create a breakout room.

Parameters

boName

the BO name.

Returns

If success the return value is YES, 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 only support in Zoomui Mode.

createGroupBO:

- (BOOL) createGroupBO:

(NSArray< NSString * > *_Nonnull)

boNameList

Create bo meetings in batches.

Parameters

boNameList

the BO name list.

Returns

Batch bo create success or not.

createWebinarBO:

- (BOOL) createWebinarBO:

(NSArray< NSString * > *_Nonnull)

boNameList

Creator webinar breakout meeting, available only For Zoomui Mode.

Parameters

boNameList

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

Returns

If the function succeeds,will return YES.

getBOOption

- (MobileRTCBOOption *_Nullable) getBOOption

Get BO option.

Returns

The BOOption value.

getWebPreAssignBODataStatus

- (MobileRTCBOPreAssignBODataStatus) getWebPreAssignBODataStatus

Get the downloading status of pre-assigned data.

Returns

The return value is a enum for download status. For more details, see [MobileRTCBOPreAssignBODataStatus].

isWebPreAssignBOEnabled

- (BOOL) isWebPreAssignBOEnabled

Check 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

Remove a bo meeting, the callback is: 'onRemoveBOResponse:BOID:'.

Parameters

boId	the BO id.

Returns

Remove bo meting success or not.

removeUser:fromBO:

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

Remove a user from a bo meeting.

Returns

Remove success or not.

requestAndUseWebPreAssignBOList

- (MobileRTCSDKError) requestAndUseWebPreAssignBOList

Request web pre-assigned data and create those rooms.

Returns

If the function succeeds, the return value is MobileRTCSDKError_Success.Otherwise failed. To get extended error information, see [MobileRTCSDKError].

setBOOption:

- (BOOL) setBOOption:

(MobileRTCBOOption *_Nonnull)

option

Set BO option.

Parameters

option

the option that you want to set.

Returns

If success the return value is YES, otherwise NO.

updateBO:name:

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

Update bo meeting name with bo id, the callback is: 'onUpdateBONameResponse:BOID'.

Parameters

boId	the BO id.
boName	the BO name.

Returns

Update success or not.