IBOAdmin Class Reference

BO admin interface. More...

#include <meeting_breakout_rooms_interface_v2.h>

Public Member Functions
virtual bool	StartBO ()=0
	start breakout room, 'IBOAdminEvent.onStartBOResponse' is the corresponding callback notification.
virtual bool	StopBO ()=0
	stop breakout room, 'IBOAdminEvent.onStopBOResponse' is the corresponding callback notification.
virtual bool	AssignNewUserToRunningBO (const zchar_t *strUserID, const zchar_t *strBOID)=0
	To set a unassigned user to a BO, when BO is started.
virtual bool	SwitchAssignedUserToRunningBO (const zchar_t *strUserID, const zchar_t *strBOID)=0
	To Switch user to other BO, when BO is started.
virtual bool	CanStartBO ()=0
	Determine if can start BO.
virtual void	SetEvent (IBOAdminEvent *pEvent)=0
	Set admin callback handler.
virtual bool	JoinBOByUserRequest (const zchar_t *strUserID)=0
	To join the BO which request help is from.
virtual bool	IgnoreUserHelpRequest (const zchar_t *strUserID)=0
	To ignore the request help.
virtual bool	BroadcastMessage (const zchar_t *strMsg)=0
	To send the broadcast message.
virtual bool	InviteBOUserReturnToMainSession (const zchar_t *strUserID)=0
	Host invite user return to main session, When BO is started and user is in BO.
virtual bool	IsBroadcastVoiceToBOSupport ()=0
	Query if the current meeting supports broadcasting host's voice to BO.
virtual bool	CanBroadcastVoiceToBO ()=0
	Query if the host now has the ability to broadcast voice to BO.
virtual bool	BroadcastVoiceToBo (bool bStart)=0
	Start or stop broadcasting voice to BO.

Detailed Description

BO admin interface.

Definition at line 344 of file meeting_breakout_rooms_interface_v2.h.

Member Function Documentation

AssignNewUserToRunningBO()

virtual bool IBOAdmin::AssignNewUserToRunningBO ( const zchar_t * strUserID, const zchar_t * strBOID )

pure virtual

To set a unassigned user to a BO, when BO is started.

Returns

true indicates success, otherwise fail.

BroadcastMessage()

virtual bool IBOAdmin::BroadcastMessage ( const zchar_t * strMsg )

pure virtual

To send the broadcast message.

Returns

true indicates success, otherwise fail.

BroadcastVoiceToBo()

virtual bool IBOAdmin::BroadcastVoiceToBo ( bool bStart )

pure virtual

Start or stop broadcasting voice to BO.

Parameters

bStart

True for start and false for stop.

Returns

true means that the invocation succeeds. Otherwise, it fails.

CanBroadcastVoiceToBO()

virtual bool IBOAdmin::CanBroadcastVoiceToBO ( )

pure virtual

Query if the host now has the ability to broadcast voice to BO.

Returns

true means that the host now has the ability, otherwise the host does not.

CanStartBO()

virtual bool IBOAdmin::CanStartBO ( )

pure virtual

Determine if can start BO.

Returns

true indicates can, otherwise can not.

IgnoreUserHelpRequest()

virtual bool IBOAdmin::IgnoreUserHelpRequest ( const zchar_t * strUserID )

pure virtual

To ignore the request help.

Returns

true indicates success, otherwise fail.

InviteBOUserReturnToMainSession()

virtual bool IBOAdmin::InviteBOUserReturnToMainSession ( const zchar_t * strUserID )

pure virtual

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

Returns

true indicates success, otherwise fail.

IsBroadcastVoiceToBOSupport()

virtual bool IBOAdmin::IsBroadcastVoiceToBOSupport ( )

pure virtual

Query if the current meeting supports broadcasting host's voice to BO.

Returns

true means that the meeting supports thised, otherwise it's not supported.

JoinBOByUserRequest()

virtual bool IBOAdmin::JoinBOByUserRequest ( const zchar_t * strUserID )

pure virtual

To join the BO which request help is from.

Returns

true indicates success, otherwise fail.

SetEvent()

virtual void IBOAdmin::SetEvent ( IBOAdminEvent * pEvent )

pure virtual

Set admin callback handler.

Parameters

pEvent,A

pointer to the IBOAdminEvent. For more details, see IBOAdminEvent.

StartBO()

virtual bool IBOAdmin::StartBO ( )

pure virtual

start breakout room, 'IBOAdminEvent.onStartBOResponse' is the corresponding callback notification.

Returns

true indicates success, otherwise fail.

StopBO()

virtual bool IBOAdmin::StopBO ( )

pure virtual

stop breakout room, 'IBOAdminEvent.onStopBOResponse' is the corresponding callback notification.

Returns

true indicates success, otherwise fail.

SwitchAssignedUserToRunningBO()

virtual bool IBOAdmin::SwitchAssignedUserToRunningBO ( const zchar_t * strUserID, const zchar_t * strBOID )

pure virtual

To Switch user to other BO, when BO is started.

Returns

true indicates success, otherwise fail.