IBOCreatorHelper Class Reference

BO creator interface. More...

#include <IBreakoutRoomHelper.h>

Inherited by IBreakoutRoomHelper.

Public Member Functions
virtual void	RegisterSink (IBOCreatorHelperSink *pSink)=0
virtual ZRCSDKError	CreateBreakoutRooms (int count, BO_ASSIGN_PARTICIPANTS_TYPE type)=0
	Create breakout rooms.
virtual ZRCSDKError	SetBOOptions (const BOOptions &boOptions)=0
	Set the BO options.
virtual ZRCSDKError	GetBOOptions (BOOptions &boOptions)=0
	Get current BO options.
virtual ZRCSDKError	AssignUsersToBO (const std::vector< std::string > &userGUIDList, const std::string &sessionBID)=0
	Assign users to a BO.
virtual ZRCSDKError	RenameBreakoutRoom (const std::string &sessionBID, const std::string &newBOName)=0
	Rename the breakout room.
virtual ZRCSDKError	AddBreakoutRoom ()=0
	Add a breakout room.
virtual ZRCSDKError	DeleteBreakoutRoom (const std::string &sessionBID)=0
	Delete breakout room.
virtual ZRCSDKError	IsWebPreAssignBOEnabled (bool &enabled)=0
	Query if web pre-assign BO options enabled.
virtual ZRCSDKError	RecoverToWebPreAssignBO ()=0
	Recover breakout rooms to web pre-assigned options.

Detailed Description

BO creator interface.

Definition at line 96 of file IBreakoutRoomHelper.h.

Member Function Documentation

AddBreakoutRoom()

virtual ZRCSDKError IBOCreatorHelper::AddBreakoutRoom ( )

pure virtual

Add a breakout room.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

This will result in a default breakout room to be added.

Returns

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

AssignUsersToBO()

virtual ZRCSDKError IBOCreatorHelper::AssignUsersToBO ( const std::vector< std::string > &  userGUIDList, const std::string &  sessionBID  )

pure virtual

Assign users to a BO.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

userGUIDList	The user GUID list, can be one if assign single user to bo.
sessionBID	The BO ID, empty string indicates to assign user back to main session.

Returns

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

CreateBreakoutRooms()

virtual ZRCSDKError IBOCreatorHelper::CreateBreakoutRooms ( int  count, BO_ASSIGN_PARTICIPANTS_TYPE  type  )

pure virtual

Create breakout rooms.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

count	Breakout rooms count.
type	Assign participants type, see BO_ASSIGN_PARTICIPANTS_TYPE enum.

Returns

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

DeleteBreakoutRoom()

virtual ZRCSDKError IBOCreatorHelper::DeleteBreakoutRoom ( const std::string &  sessionBID )

pure virtual

Delete breakout room.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

sessionBID

Specify the BID of the room to delete.

Returns

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

GetBOOptions()

virtual ZRCSDKError IBOCreatorHelper::GetBOOptions ( BOOptions &  boOptions )

pure virtual

Get current BO options.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

[out]

boOptions

Current BO options.

Returns

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

IsWebPreAssignBOEnabled()

virtual ZRCSDKError IBOCreatorHelper::IsWebPreAssignBOEnabled ( bool &  enabled )

pure virtual

Query if web pre-assign BO options enabled.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

[out]

enabled

TRUE indicates web pre-assign BO options enabled.

Returns

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

RecoverToWebPreAssignBO()

virtual ZRCSDKError IBOCreatorHelper::RecoverToWebPreAssignBO ( )

pure virtual

Recover breakout rooms to web pre-assigned options.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Returns

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

RegisterSink()

virtual void IBOCreatorHelper::RegisterSink ( IBOCreatorHelperSink *  pSink )

pure virtual

RenameBreakoutRoom()

virtual ZRCSDKError IBOCreatorHelper::RenameBreakoutRoom ( const std::string &  sessionBID, const std::string &  newBOName  )

pure virtual

Rename the breakout room.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

sessionBID	Specify the BID of the room to rename.
newBOName	Specify the new BO room name.

Returns

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

SetBOOptions()

virtual ZRCSDKError IBOCreatorHelper::SetBOOptions ( const BOOptions &  boOptions )

pure virtual

Set the BO options.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

[in]

boOptions

The configured BO options.

Returns

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