IBOCreator Class Reference

BO creator interface. More...

#include <meeting_breakout_rooms_interface_v2.h>

Public Member Functions
virtual void	SetEvent (IBOCreatorEvent *pEvent)=0
virtual const zchar_t *	CreateBO (const zchar_t *strBOName)=0
	Create a BO.
virtual bool	CreateBreakoutRoom (const zchar_t *strBOName)=0
	Create a breakout room.
virtual bool	UpdateBOName (const zchar_t *strBOID, const zchar_t *strNewBOName)=0
	Update BO name, 'IBOCreatorEvent.onUpdateBONameResponse' is the corresponding callback notification.
virtual bool	RemoveBO (const zchar_t *strBOID)=0
	Remove a breakout room, 'IBOCreatorEvent.onRemoveBOResponse' is the corresponding callback notification.
virtual bool	AssignUserToBO (const zchar_t *strUserID, const zchar_t *strBOID)=0
	Assign a user to a BO.
virtual bool	RemoveUserFromBO (const zchar_t *strUserID, const zchar_t *strBOID)=0
	Remove some user from a BO.
virtual bool	SetBOOption (const BOOption &option)=0
	Set BO option.
virtual bool	GetBOOption (BOOption &option)=0
	Get BO option.
virtual IBatchCreateBOHelper *	GetBatchCreateBOHelper ()=0
	Get the Batch create bo controller.
virtual bool	IsWebPreAssignBOEnabled ()=0
	Determine whether web enabled the pre-assigned option when scheduling a meeting.
virtual SDKError	RequestAndUseWebPreAssignBOList ()=0
	Request web pre-assigned data and create those rooms.
virtual PreAssignBODataStatus	GetWebPreAssignBODataStatus ()=0
	Get the pre-assigned data download status.
virtual bool	CreateWebinarBo (const zchar_t *strBOName)=0
	Create a Webinar BO, Available Only For Zoomui Mode.

Detailed Description

BO creator interface.

Definition at line 222 of file meeting_breakout_rooms_interface_v2.h.

Member Function Documentation

AssignUserToBO()

virtual bool IBOCreator::AssignUserToBO ( const zchar_t * strUserID, const zchar_t * strBOID )

pure virtual

Assign a user to a BO.

Parameters

strUserID,is	the user ID.
strBOID,is	the BO ID.

Returns

if success the return value is true, otherwise false.

CreateBO()

virtual const zchar_t * IBOCreator::CreateBO ( const zchar_t * strBOName )

pure virtual

Create a BO.

Parameters

strBOName,the

BO name.

Returns

if success the return value is BO ID, otherwise nullptr.

Deprecated

This interface is marked as deprecated, and it is recommended to use 'CreateBreakoutRoom(const zchar_t* strBOName)'.

CreateBreakoutRoom()

virtual bool IBOCreator::CreateBreakoutRoom ( const zchar_t * strBOName )

pure virtual

Create a breakout room.

Parameters

strBOName,the

breakout room name.

Returns

if success the return value is true. Otherwise false. Note:

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

CreateWebinarBo()

virtual bool IBOCreator::CreateWebinarBo ( const zchar_t * strBOName )

pure virtual

Create a Webinar BO, Available Only For Zoomui Mode.

Parameters

strBOName,the

BO name.

Returns

if success the return value is true, otherwise false.

Deprecated

This interface is marked as deprecated, and it is recommended to use 'CreateBreakoutRoom(const zchar_t* strBOName)'.

GetBatchCreateBOHelper()

virtual IBatchCreateBOHelper * IBOCreator::GetBatchCreateBOHelper ( )

pure virtual

Get the Batch create bo controller.

Returns

If the function succeeds, the return value is a pointer to IBatchCreateBOHelper. Otherwise returns nullptr.

GetBOOption()

virtual bool IBOCreator::GetBOOption ( BOOption & option )

pure virtual

Get BO option.

Parameters

option,Get

the current bo option through this parameter.

Returns

if success the return value is true, otherwise false.

GetWebPreAssignBODataStatus()

virtual PreAssignBODataStatus IBOCreator::GetWebPreAssignBODataStatus ( )

pure virtual

Get the pre-assigned data download status.

Returns

The return value is a enum for download status. For more details, see PreAssignBODataStatus.

IsWebPreAssignBOEnabled()

virtual bool IBOCreator::IsWebPreAssignBOEnabled ( )

pure virtual

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

Returns

true if it is enabled, otherwise false.

RemoveBO()

virtual bool IBOCreator::RemoveBO ( const zchar_t * strBOID )

pure virtual

Remove a breakout room, 'IBOCreatorEvent.onRemoveBOResponse' is the corresponding callback notification.

Parameters

strBOID,is

the breakout room ID.

Returns

if success the return value is true. Otherwise false.

RemoveUserFromBO()

virtual bool IBOCreator::RemoveUserFromBO ( const zchar_t * strUserID, const zchar_t * strBOID )

pure virtual

Remove some user from a BO.

Parameters

strUserID,is	the user ID.
strBOID,is	the BO ID.

Returns

if success the return value is true, otherwise false.

RequestAndUseWebPreAssignBOList()

virtual SDKError IBOCreator::RequestAndUseWebPreAssignBOList ( )

pure virtual

Request web pre-assigned data and create those rooms.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum

SetBOOption()

virtual bool IBOCreator::SetBOOption ( const BOOption & option )

pure virtual

Set BO option.

Parameters

option,the

option that you want to set.

Returns

if success the return value is true, otherwise false.

SetEvent()

virtual void IBOCreator::SetEvent ( IBOCreatorEvent * pEvent )

pure virtual

UpdateBOName()

virtual bool IBOCreator::UpdateBOName ( const zchar_t * strBOID, const zchar_t * strNewBOName )

pure virtual

Update BO name, 'IBOCreatorEvent.onUpdateBONameResponse' is the corresponding callback notification.

Parameters

strBOID,is	the breakout room's ID.
strNewBOName,is	the new breakout room's name.

Returns

if success the return value is true. Otherwise false.