IBOAdminHelper Class Reference

BO admin interface. More...

#include <IBreakoutRoomHelper.h>

Inherited by IBreakoutRoomHelper.

Public Member Functions
virtual void	RegisterSink (IBOAdminHelperSink *pSink)=0
virtual ZRCSDKError	StartBreakoutRooms ()=0
	Start all breakout rooms.
virtual ZRCSDKError	StopBreakoutRooms ()=0
	Stop all breakout rooms.
virtual ZRCSDKError	MoveUserToRunningBO (const std::string &userGUID, const std::string &sessionBID)=0
	Assign a unassigned user to a BO, when BO is started.
virtual ZRCSDKError	InviteBOUserReturnToMainSession (const std::string &userGUID)=0
	Host invite user return to main session, When BO is started and user is in BO.
virtual ZRCSDKError	JoinBOByUserRequest (const std::string &userGUID, const BreakoutRoomInfo &boRoomInfo)=0
	Join breakout room by user help request.
virtual ZRCSDKError	IgnoreUserHelpRequest (const std::string &userGUID)=0
	Ignore user help request.
virtual ZRCSDKError	BroadcastMessageToBreakoutRoom (const std::string &message)=0
	Broadcast message to all breakout rooms.
virtual ZRCSDKError	CanBroadcastMessageToBO (bool &canBroadcast)=0
	Query if you can broadcast message to BO.

Detailed Description

BO admin interface.

Definition at line 250 of file IBreakoutRoomHelper.h.

Member Function Documentation

BroadcastMessageToBreakoutRoom()

virtual ZRCSDKError IBOAdminHelper::BroadcastMessageToBreakoutRoom ( const std::string &  message )

pure virtual

Broadcast message to all breakout rooms.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

message

The message.

Returns

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

CanBroadcastMessageToBO()

virtual ZRCSDKError IBOAdminHelper::CanBroadcastMessageToBO ( bool &  canBroadcast )

pure virtual

Query if you can broadcast message to BO.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

[out]

canBroadcast

TRUE indicates you can broadcast message to BO.

Returns

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

IgnoreUserHelpRequest()

virtual ZRCSDKError IBOAdminHelper::IgnoreUserHelpRequest ( const std::string &  userGUID )

pure virtual

Ignore user help request.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

userGUID

The user guid.

Returns

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

InviteBOUserReturnToMainSession()

virtual ZRCSDKError IBOAdminHelper::InviteBOUserReturnToMainSession ( const std::string &  userGUID )

pure virtual

Host invite user return to main session, When BO is started and user is in BO.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

userGUID

The user GUID.

Returns

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

JoinBOByUserRequest()

virtual ZRCSDKError IBOAdminHelper::JoinBOByUserRequest ( const std::string &  userGUID, const BreakoutRoomInfo &  boRoomInfo  )

pure virtual

Join breakout room by user help request.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

userGUID	The user guid.
boRoomInfo	The BO room info.

Returns

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

MoveUserToRunningBO()

virtual ZRCSDKError IBOAdminHelper::MoveUserToRunningBO ( const std::string &  userGUID, const std::string &  sessionBID  )

pure virtual

Assign a unassigned user to a BO, when BO is started.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

userGUID	The user GUID.
sessionBID	The BO ID.

Returns

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

RegisterSink()

virtual void IBOAdminHelper::RegisterSink ( IBOAdminHelperSink *  pSink )

pure virtual

StartBreakoutRooms()

virtual ZRCSDKError IBOAdminHelper::StartBreakoutRooms ( )

pure virtual

Start all breakout rooms.

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.

StopBreakoutRooms()

virtual ZRCSDKError IBOAdminHelper::StopBreakoutRooms ( )

pure virtual

Stop all breakout rooms.

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.