Breakout Room helper interface. More...

#include <IBreakoutRoomHelper.h>

Inherits IBOCreatorHelper, IBOAdminHelper, IBOAssistantHelper, IBOAttendeeHelper, and IBODataHelper.

Public Member Functions
virtual	~IBreakoutRoomHelper ()

virtual ZRCSDKError	RegisterSink (IBreakoutRoomHelperSink *pSink)=0
	Register breakout room help callback sink.

virtual ZRCSDKError	DeregisterSink (IBreakoutRoomHelperSink *pSink)=0
	Deregister breakout room help callback sink.

virtual IBOCreatorHelper *	GetBOCreatorHelper ()=0
	Get the pointer of BO creator object.

virtual IBOAdminHelper *	GetBOAdminHelper ()=0
	Get the pointer of BO administrator object.

virtual IBOAssistantHelper *	GetBOAssistantHelper ()=0
	Get the pointer of BO assistant object.

virtual IBOAttendeeHelper *	GetBOAttendeeHelper ()=0
	Get the pointer of BO attendee object.

virtual IBODataHelper *	GetBODataHelper ()=0
	Get the pointer of BO data object.

virtual ZRCSDKError	IsBOEnabled (bool &enabled)=0
	Determine if the BO feature is enabled in current meeting.

virtual ZRCSDKError	IsBOStarted (bool &started)=0
	Determine if the BO is started or not.

virtual ZRCSDKError	IsInMainSession (bool &isInMainSession)=0
	Query if you are in main session.

virtual ZRCSDKError	GetBOStatus (BO_STATUS &boStatus)=0
	Query current breakout room status.

Public Member Functions inherited from IBOCreatorHelper
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.

Public Member Functions inherited from IBOAdminHelper
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.

Public Member Functions inherited from IBOAssistantHelper
virtual ZRCSDKError	JoinBreakoutRoom (const std::string &sessionBID)=0
	Join breakout room.

virtual ZRCSDKError	LeaveBreakoutRoom (const std::string &sessionBID)=0
	Leave breakout room.

virtual ZRCSDKError	ResponseHostInviteToMainSession (bool accept)=0
	Response host invite to main session when receiving OnHostInviteReturnToMainSession.

Public Member Functions inherited from IBOAttendeeHelper
virtual void	RegisterSink (IBOAttendeeHelperSink *pSink)=0

virtual ZRCSDKError	JoinBreakoutRoom ()=0
	Join the assigned breakout room.

virtual ZRCSDKError	LeaveBreakoutRoom ()=0
	Leave breakout room.

virtual ZRCSDKError	AskHostForHelpInBO ()=0
	Ask host for help when you are in need in BO.

virtual ZRCSDKError	IsHostInThisBO (bool &in)=0
	Determine if host is in the BO which attendee is assigned to.

virtual ZRCSDKError	IsCanReturnMainSession (bool &canReturn)=0
	Determine if participant can return to main session.

Public Member Functions inherited from IBODataHelper
virtual void	RegisterSink (IBODataHelperSink *pSink)=0

virtual ZRCSDKError	GetBOUserStatus (BO_USER_STATUS &boUserStatus)=0
	Query self breakout room user status.

virtual ZRCSDKError	GetBreakoutRoomList (std::vector< BreakoutRoomInfo > &boRoomList)=0
	Get all breakout room info list.

virtual ZRCSDKError	GetBreakoutRoomUserList (std::vector< MeetingParticipant > &userList)=0
	Get all breakout rooms' user list.

Detailed Description

Breakout Room helper interface.

Definition at line 674 of file IBreakoutRoomHelper.h.

Constructor & Destructor Documentation

◆ ~IBreakoutRoomHelper()

virtual IBreakoutRoomHelper::~IBreakoutRoomHelper ( )

inlinevirtual

Definition at line 682 of file IBreakoutRoomHelper.h.

682{}

Member Function Documentation

◆ DeregisterSink()

virtual ZRCSDKError IBreakoutRoomHelper::DeregisterSink ( IBreakoutRoomHelperSink * pSink )

pure virtual

Deregister breakout room help callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IBreakoutRoomHelperSink that receives the breakout room help callback.

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

◆ GetBOAdminHelper()

virtual IBOAdminHelper * IBreakoutRoomHelper::GetBOAdminHelper ( )

pure virtual

Get the pointer of BO administrator object.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is a pointer to IBOAdminHelper object. For more details, see IBOAdminHelper. Otherwise failed, the return value is NULL.

◆ GetBOAssistantHelper()

virtual IBOAssistantHelper * IBreakoutRoomHelper::GetBOAssistantHelper ( )

pure virtual

Get the pointer of BO assistant object.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is a pointer to IBOAssistantHelper object. For more details, see IBOAssistantHelper. Otherwise failed, the return value is NULL.

◆ GetBOAttendeeHelper()

virtual IBOAttendeeHelper * IBreakoutRoomHelper::GetBOAttendeeHelper ( )

pure virtual

Get the pointer of BO attendee object.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is a pointer to IBOAttendeeHelper object. For more details, see IBOAttendeeHelper. Otherwise failed, the return value is NULL.

◆ GetBOCreatorHelper()

virtual IBOCreatorHelper * IBreakoutRoomHelper::GetBOCreatorHelper ( )

pure virtual

Get the pointer of BO creator object.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is a pointer to IBOCreatorHelper object. For more details, see IBOCreatorHelper. Otherwise failed, the return value is NULL.

◆ GetBODataHelper()

virtual IBODataHelper * IBreakoutRoomHelper::GetBODataHelper ( )

pure virtual

Get the pointer of BO data object.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is a pointer to IBODataHelper object. For more details, see IBODataHelper. Otherwise failed, the return value is NULL.

◆ GetBOStatus()

virtual ZRCSDKError IBreakoutRoomHelper::GetBOStatus ( BO_STATUS & boStatus )

pure virtual

Query current breakout room status.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] boStatus The bo status, see BO_STATUS enum.

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

◆ IsBOEnabled()

virtual ZRCSDKError IBreakoutRoomHelper::IsBOEnabled ( bool & enabled )

pure virtual

Determine if the BO feature is enabled in current meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] enabled TRUE indicates breakout room is enabled in this meeting.

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

◆ IsBOStarted()

virtual ZRCSDKError IBreakoutRoomHelper::IsBOStarted ( bool & started )

pure virtual

Determine if the BO is started or not.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] started TRUE indicates breakout room is started or stopping, see BO_STATUS enum.

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

◆ IsInMainSession()

virtual ZRCSDKError IBreakoutRoomHelper::IsInMainSession ( bool & isInMainSession )

pure virtual

Query if you are in main session.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] isInMainSession TRUE indicates you are in main session.

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

◆ RegisterSink()

virtual ZRCSDKError IBreakoutRoomHelper::RegisterSink ( IBreakoutRoomHelperSink * pSink )

pure virtual

Register breakout room help callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IBreakoutRoomHelperSink that receives the breakout room help callback.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IBreakoutRoomHelper()

Member Function Documentation

◆ DeregisterSink()

◆ GetBOAdminHelper()

◆ GetBOAssistantHelper()

◆ GetBOAttendeeHelper()

◆ GetBOCreatorHelper()

◆ GetBODataHelper()

◆ GetBOStatus()

◆ IsBOEnabled()

◆ IsBOStarted()

◆ IsInMainSession()

◆ RegisterSink()